Interface QueryOptions<TQuery, TDataset, TProjectId>`Beta`

interface QueryOptions<
    TQuery extends string = string,
    TDataset extends string = string,
    TProjectId extends string = string,
> {
    dataset?: TDataset;
    params?: Record<string, unknown>;
    perspective?: ReleasePerspective | ClientPerspective;
    projectId?: TProjectId;
    query: TQuery;
    source?: DocumentSource;
    sourceName?: string;
}

Type Parameters

TQuery extends string = string
TDataset extends string = string
TProjectId extends string = string

Hierarchy (View Summary)

Pick<ResponseQueryOptions, "useCdn" | "cache" | "next" | "cacheMode" | "tag">
DatasetHandle<TDataset, TProjectId>
- QueryOptions

Index

Properties

dataset? params? perspective? projectId? query source? sourceName?

Properties

`Optional` `Beta`dataset

dataset?: TDataset

`Optional` `Beta`params

params?: Record<string, unknown>

`Optional` `Beta`perspective

perspective?: ReleasePerspective | ClientPerspective

`Optional` `Beta`projectId

projectId?: TProjectId

`Beta`query

query: TQuery

`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.