Interface DocumentsOptions<TDocumentType, TDataset, TProjectId>

Configuration options for the useDocuments hook

interface DocumentsOptions<
    TDocumentType extends string = string,
    TDataset extends string = string,
    TProjectId extends string = string,
> {
    batchSize?: number;
    dataset?: TDataset;
    documentType?: TDocumentType | TDocumentType[];
    filter?: string;
    orderings?: SortOrderingItem[];
    params?: Record<string, unknown>;
    perspective?: ReleasePerspective | ClientPerspective;
    projectId?: TProjectId;
    search?: string;
}

Type Parameters

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

Hierarchy (View Summary)

DatasetHandle<TDataset, TProjectId>
Pick<QueryOptions, "perspective" | "params">
- DocumentsOptions

Index

Properties

batchSize? dataset? documentType? filter? orderings? params? perspective? projectId? search?

Properties

`Optional`batchSize

batchSize?: number

Number of items to load per batch (defaults to 25)

`Optional`dataset

dataset?: TDataset

`Optional`documentType

documentType?: TDocumentType | TDocumentType[]

Filter documents by their _type. Can be a single type or an array of types.

`Optional`filter

filter?: string

GROQ filter expression to apply to the query

`Optional`orderings

orderings?: SortOrderingItem[]

Sorting configuration for the results

`Optional`params

params?: Record<string, unknown>

`Optional`perspective

perspective?: ReleasePerspective | ClientPerspective

`Optional`projectId

projectId?: TProjectId

`Optional`search

search?: string

Text search query to filter results