Interface DatasetHandle<TDataset, TProjectId>

Represents the minimal configuration required to identify a Sanity project.

interface DatasetHandle<
    TDataset extends string = string,
    TProjectId extends string = string,
> {
    dataset?: TDataset;
    perspective?: ReleasePerspective | ClientPerspective;
    projectId?: TProjectId;
    source?: DocumentSource;
    sourceName?: string;
}

Type Parameters

TDataset extends string = string
TProjectId extends string = string

Hierarchy (View Summary)

ProjectHandle<TProjectId>
PerspectiveHandle
- DatasetHandle

Index

Properties

dataset? perspective? projectId? source? sourceName?

Properties

`Optional`dataset

dataset?: TDataset

`Optional`perspective

perspective?: ReleasePerspective | ClientPerspective

`Optional`projectId

projectId?: TProjectId

`Optional` `Beta`source

source?: DocumentSource

Explicit source object to use for this operation.

`Optional` `Beta`sourceName

sourceName?: string

The name of the source to use for this operation.