Sanity Library Reference Docs
    Preparing search index...

    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$1;
        projectId?: TProjectId;
        resource?: DocumentResource;
        resourceName?: string;
        search?: string;
    }

    Type Parameters

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

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    batchSize?: number

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

    dataset?: TDataset
    documentType?: TDocumentType | TDocumentType[]

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

    filter?: string

    GROQ filter expression to apply to the query

    orderings?: SortOrderingItem[]

    Sorting configuration for the results

    params?: Record<string, unknown>
    perspective?: ReleasePerspective | ClientPerspective$1
    projectId?: TProjectId
    resource?: DocumentResource

    Explicit resource to use. On an individual operation this overrides any default; on a SanityConfig it becomes the instance's default resource. Unlike projectId/dataset, this can also be a media library or canvas resource.

    resourceName?: string

    Name of a resource registered via the resources prop on <SanityApp>. Resolved to a DocumentResource at the React layer.

    search?: string

    Text search query to filter results

    Settings

    Member Visibility

    On This Page

    Properties