@r1tsu/payload
Version:
33 lines • 1.76 kB
TypeScript
import type { Payload } from '../../../index.js';
import type { GeneratedTypes } from '../../../index.js';
import type { PayloadRequestWithData, RequestContext } from '../../../types/index.js';
import type { Document, Where } from '../../../types/index.js';
import type { BulkOperationResult } from '../../config/types.js';
export type BaseOptions<T extends keyof GeneratedTypes['collections']> = {
collection: T;
/**
* context, which will then be passed to req.context, which can be read by hooks
*/
context?: RequestContext;
depth?: number;
fallbackLocale?: GeneratedTypes['locale'];
locale?: GeneratedTypes['locale'];
overrideAccess?: boolean;
req?: PayloadRequestWithData;
showHiddenFields?: boolean;
user?: Document;
};
export type ByIDOptions<T extends keyof GeneratedTypes['collections']> = BaseOptions<T> & {
id: number | string;
where?: never;
};
export type ManyOptions<T extends keyof GeneratedTypes['collections']> = BaseOptions<T> & {
id?: never;
where: Where;
};
export type Options<TSlug extends keyof GeneratedTypes['collections']> = ByIDOptions<TSlug> | ManyOptions<TSlug>;
declare function deleteLocal<TSlug extends keyof GeneratedTypes['collections']>(payload: Payload, options: ByIDOptions<TSlug>): Promise<GeneratedTypes['collections'][TSlug]>;
declare function deleteLocal<TSlug extends keyof GeneratedTypes['collections']>(payload: Payload, options: ManyOptions<TSlug>): Promise<BulkOperationResult<TSlug>>;
declare function deleteLocal<TSlug extends keyof GeneratedTypes['collections']>(payload: Payload, options: Options<TSlug>): Promise<BulkOperationResult<TSlug> | GeneratedTypes['collections'][TSlug]>;
export default deleteLocal;
//# sourceMappingURL=delete.d.ts.map