payload
Version:
Node, React, Headless CMS and Application Framework built on Next.js
95 lines • 4.28 kB
TypeScript
import type { Document, PayloadRequest, PopulateType, SelectType, TransformCollectionWithSelect } from '../../../types/index.js';
import type { File } from '../../../uploads/types.js';
import type { DataFromCollectionSlug, RequiredDataFromCollectionSlug, SelectFromCollectionSlug } from '../../config/types.js';
import { type CollectionSlug, type Payload, type RequestContext, type TypedLocale } from '../../../index.js';
export type Options<TSlug extends CollectionSlug, TSelect extends SelectType> = {
/**
* the Collection slug to operate against.
*/
collection: TSlug;
/**
* [Context](https://payloadcms.com/docs/hooks/context), which will then be passed to `context` and `req.context`,
* which can be read by hooks. Useful if you want to pass additional information to the hooks which
* shouldn't be necessarily part of the document, for example a `triggerBeforeChange` option which can be read by the BeforeChange hook
* to determine if it should run or not.
*/
context?: RequestContext;
/**
* The data for the document to create.
*/
data: RequiredDataFromCollectionSlug<TSlug>;
/**
* [Control auto-population](https://payloadcms.com/docs/queries/depth) of nested relationship and upload fields.
*/
depth?: number;
/**
* When set to `true`, a [database transactions](https://payloadcms.com/docs/database/transactions) will not be initialized.
* @default false
*/
disableTransaction?: boolean;
/**
* If creating verification-enabled auth doc,
* you can disable the email that is auto-sent
*/
disableVerificationEmail?: boolean;
/**
* Create a **draft** document. [More](https://payloadcms.com/docs/versions/drafts#draft-api)
*/
draft?: boolean;
/**
* If you want to create a document that is a duplicate of another document
*/
duplicateFromID?: DataFromCollectionSlug<TSlug>['id'];
/**
* Specify a [fallback locale](https://payloadcms.com/docs/configuration/localization) to use for any returned documents.
*/
fallbackLocale?: false | TypedLocale;
/**
* A `File` object when creating a collection with `upload: true`.
*/
file?: File;
/**
* A file path when creating a collection with `upload: true`.
*/
filePath?: string;
/**
* Specify [locale](https://payloadcms.com/docs/configuration/localization) for any returned documents.
*/
locale?: TypedLocale;
/**
* Skip access control.
* Set to `false` if you want to respect Access Control for the operation, for example when fetching data for the fron-end.
* @default true
*/
overrideAccess?: boolean;
/**
* If you are uploading a file and would like to replace
* the existing file instead of generating a new filename,
* you can set the following property to `true`
*/
overwriteExistingFiles?: boolean;
/**
* Specify [populate](https://payloadcms.com/docs/queries/select#populate) to control which fields to include to the result from populated documents.
*/
populate?: PopulateType;
/**
* The `PayloadRequest` object. You can pass it to thread the current [transaction](https://payloadcms.com/docs/database/transactions), user and locale to the operation.
* Recommended to pass when using the Local API from hooks, as usually you want to execute the operation within the current transaction.
*/
req?: Partial<PayloadRequest>;
/**
* Specify [select](https://payloadcms.com/docs/queries/select) to control which fields to include to the result.
*/
select?: TSelect;
/**
* Opt-in to receiving hidden fields. By default, they are hidden from returned documents in accordance to your config.
* @default false
*/
showHiddenFields?: boolean;
/**
* If you set `overrideAccess` to `false`, you can pass a user to use against the access control checks.
*/
user?: Document;
};
export default function createLocal<TSlug extends CollectionSlug, TSelect extends SelectFromCollectionSlug<TSlug>>(payload: Payload, options: Options<TSlug, TSelect>): Promise<TransformCollectionWithSelect<TSlug, TSelect>>;
//# sourceMappingURL=create.d.ts.map