Sanity Library Reference Docs
    Preparing search index...

    Interface DocumentHandle<TDocumentType, TDataset, TProjectId>

    React SDK document handle. Adds resourceName to the core DocumentHandle.

    Import from @sanity/sdk-react (not @sanity/sdk) when writing option types for hooks — this version understands resourceName resolution.

    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;
        resource?: DocumentResource;
        resourceName?: string;
        source?: DocumentResource;
    }

    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? resource? resourceName? source?

    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
    resource?: DocumentResource

    Explicit resource object to use for this operation.

    resourceName?: string
    source?: DocumentResource

    Use resource instead.

    Settings

    Member Visibility

    On This Page

    Properties