Sanity Library Reference Docs
    Preparing search index...

    Interface CommentsQueryOptionsBeta

    An arbitrary comment query, for anything that is not "comments on this document" — cross-document views, per-user views, organization-wide activity.

    interface CommentsQueryOptions {
        dataset?: string;
        filter: string;
        params?: QueryParams;
        perspective?: ReleasePerspective | ClientPerspective$1;
        projectId?: string;
        resource?: DocumentResource;
    }

    Hierarchy (View Summary)

    Index

    Properties

    dataset? filter params? perspective? projectId? resource?

    Properties

    dataset?: string
    filter: string

    GROQ filter applied to comment documents. _type == "sanity.comment" is added for you, so this only has to say which comments.

    It is evaluated against every comment the organization can read. The resource picks the organization but does not narrow the results; add a target.document._ref prefix condition to keep to one dataset.

    params?: QueryParams
    perspective?: ReleasePerspective | ClientPerspective$1
    projectId?: string
    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.

    Settings

    Member Visibility

    On This Page

    Properties