Interface DocumentTypeHandle<TDocumentType, TDataset, TProjectId>

Identifies a specific document type within a Sanity dataset and project. Includes projectId, dataset, and documentType. Optionally includes a documentId, useful for referencing a specific document type context, potentially without a specific document ID.

interface DocumentTypeHandle<
    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)

DatasetHandle<TDataset, TProjectId>
- DocumentTypeHandle
  - DocumentHandle
  - CreateDocumentAction

Index

Properties

dataset? documentId? documentType perspective? projectId?

Properties

`Optional`dataset

dataset?: TDataset

`Optional`documentId

documentId?: string

documentType

documentType: TDocumentType

`Optional`perspective

perspective?: ReleasePerspective | ClientPerspective

`Optional`projectId

projectId?: TProjectId