Sanity Library Reference Docs
    Preparing search index...

    Interface CreateDocumentAction<TDocumentType, TDataset, TProjectId>Beta

    Represents an action to create a new document. Specifies the document type and optionally a document ID (which will be treated as the published ID).

    interface CreateDocumentAction<
        TDocumentType extends string = string,
        TDataset extends string = string,
        TProjectId extends string = string,
    > {
        dataset?: TDataset;
        documentId?: string;
        documentType: TDocumentType;
        initialValue?: Partial<
            Omit<
                SanityDocument<TDocumentType, `${TProjectId}.${TDataset}`>,
                "_rev" | "_createdAt" | "_type" | "_id" | "_updatedAt",
            >,
        >;
        liveEdit?: boolean;
        perspective?: ReleasePerspective | ClientPerspective$1;
        projectId?: TProjectId;
        resource?: DocumentResource;
        type: "document.create";
    }

    Type Parameters

    • TDocumentType extends string = string
    • TDataset extends string = string
    • TProjectId extends string = string

    Hierarchy (View Summary)

    Index

    Properties

    dataset? documentId? documentType initialValue? liveEdit? perspective? projectId? resource? type

    Properties

    dataset?: TDataset
    documentId?: string
    documentType: TDocumentType
    initialValue?: Partial<
        Omit<
            SanityDocument<TDocumentType, `${TProjectId}.${TDataset}`>,
            "_rev" | "_createdAt" | "_type" | "_id" | "_updatedAt",
        >,
    >

    Optional initial field values for the document. These values will be set when the document is created. System fields (_id, _type, _rev, _createdAt, _updatedAt) are omitted as they are set automatically.

    liveEdit?: boolean

    Indicates whether this document uses liveEdit mode. When true, the document does not use the draft/published model and edits are applied directly to the document.

    https://www.sanity.io/docs/content-lake/drafts#ca0663a8f002

    perspective?: ReleasePerspective | ClientPerspective$1
    projectId?: TProjectId
    resource?: DocumentResource

    Explicit resource to use. On an individual operation this overrides any default; on a SanityConfig it becomes the instance's default resource. Unlike projectId/dataset, this can also be a media library or canvas resource.

    type: "document.create"

    Settings

    Member Visibility

    On This Page

    Properties