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;
    perspective?: ReleasePerspective | ClientPerspective;
    projectId?: TProjectId;
}

Type Parameters

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

Hierarchy (View Summary)

DocumentTypeHandle<TDocumentType, TDataset, TProjectId>
- DocumentHandle

Index

Properties

dataset? documentId documentType perspective? projectId?

Properties

`Optional`dataset

dataset?: TDataset

documentId

documentId: string

documentType

documentType: TDocumentType

`Optional`perspective

perspective?: ReleasePerspective | ClientPerspective

`Optional`projectId

projectId?: TProjectId