interface GraphqlRequestParams
Since 0.1.0

Parameters for a GraphQL execution request.

These are produced by the HTTP request parser and consumed by IGraphqlService.execute.

Properties

query: string

The GraphQL query string.

optional
operationName: string

Operation name for documents with multiple operations.

optional
variables: Record<string, unknown>

Variables as a record of unknown values (passed through verbatim).

Since 0.3.0
optional
extensions: Record<string, unknown>

Optional extensions carried with the request.

Used by Automatic Persisted Queries (APQ) to pass { version, sha256Hash } under the persistedQuery key. Other extensions are forwarded without interpretation by the framework.

Usage

import { type GraphqlRequestParams } from "graphql-plugin/src/index.ts";