Interface useDocumentProjectionOptions<TProjection, TDocumentType, TDataset, TProjectId>

interface useDocumentProjectionOptions<
    TProjection extends ValidProjection = ValidProjection,
    TDocumentType extends string = string,
    TDataset extends string = string,
    TProjectId extends string = string,
> {
    dataset?: TDataset;
    documentId: string;
    documentType: TDocumentType;
    params?: Record<string, unknown>;
    perspective?: ReleasePerspective | ClientPerspective;
    projectId?: TProjectId;
    projection: TProjection;
    ref?: RefObject<unknown>;
}

Type Parameters

TProjection extends ValidProjection = ValidProjection
TDocumentType extends string = string
TDataset extends string = string
TProjectId extends string = string

Hierarchy (View Summary)

DocumentHandle<TDocumentType, TDataset, TProjectId>
- useDocumentProjectionOptions

Index

Properties

dataset? documentId documentType params? perspective? projectId? projection ref?

Properties

`Optional`dataset

dataset?: TDataset

documentId

documentId: string

documentType

documentType: TDocumentType

`Optional`params

params?: Record<string, unknown>

Optional parameters for the projection query

`Optional`perspective

perspective?: ReleasePerspective | ClientPerspective

`Optional`projectId

projectId?: TProjectId

projection

projection: TProjection

The GROQ projection string

`Optional`ref

ref?: RefObject<unknown>

Optional ref to track viewport intersection for lazy loading