Sanity Library Reference Docs
    Preparing search index...

    Interface DocumentHandle<TDocumentType, TDataset, TProjectId>

    Uniquely identifies a specific document within a Sanity dataset and project. Includes projectId, dataset, documentType, and the required documentId. Commonly used by document-related hooks and components to reference a document without fetching its full content initially.

    interface DocumentHandle<
        TDocumentType extends string = string,
        TDataset extends string = string,
        TProjectId extends string = string,
    > {
        dataset?: TDataset;
        documentId: string;
        documentType: TDocumentType;
        liveEdit?: boolean;
        perspective?: ReleasePerspective | ClientPerspective;
        projectId?: TProjectId;
        source?: DocumentSource;
        sourceName?: string;
    }

    Type Parameters

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

    Hierarchy (View Summary)

    Index

    Properties

    dataset? documentId documentType liveEdit? perspective? projectId? source? sourceName?

    Properties

    dataset?: TDataset
    documentId: string
    documentType: TDocumentType
    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
    projectId?: TProjectId
    source?: DocumentSource

    Explicit source object to use for this operation.

    sourceName?: string

    The name of the source to use for this operation.

    Settings

    Member Visibility

    On This Page

    Properties