On this page

TypedDocumentNode

Generate TypedDocumentNode for GraphQL operations. This plugin is a wrapper for graphql-typed-document-node.

Version
7.1.0
Weekly downloads
4.8M
License
MIT
Updated
Jul 6, 2026

Installation

          npm i -D @graphql-codegen/typed-document-node
        

These plugins generate a ready-to-use TypedDocumentNode (a combination of pre-compiled DocumentNode and the TypeScript signature it represents).

With the typed-document-node plugin you no longer need to reconfigure, and install different GraphQL Code Generator plugins to manage all your GraphQL client hooks. Generate a single TypedDocumentNode and pass it to your GraphQL client of choice.

This plugin also generates less boilerplate code for your GraphQL operations.

Usage example

codegen.ts
import type { CodegenConfig } from '@graphql-codegen/cli'

const config: CodegenConfig = {
  schema: 'SCHEMA_FILE_OR_ENDPOINT_HERE',
  documents: './src/**/*.graphql',
  generates: {
    './src/graphql-operations.ts': {
      plugins: ['typescript-operations', 'typed-document-node']
    }
  }
}
export default config

The example about will generate TypedDocumentNode with the needed types built-in, for example:

// Represents the variables type of the operation - generated by `typescript` + `typescript-operations` plugins
export type RatesQueryVariables = Exact<{
  currency: Scalars['String'];
}>;

// Represents the result type of the operation - generated by `typescript` + `typescript-operations` plugins
export type RatesQuery = (
  { __typename?: 'Query' }
  & {
  rates?: Maybe<Array<Maybe<(
    { __typename?: 'ExchangeRate' }
    & Pick<ExchangeRate, 'currency' | 'rate'>
    )>>>
}
  )

// Generated by this plugin - creates a pre-compiled `DocumentNode` and passes result type and variables type as generics
export const ratesQuery: TypedDocumentNode<RatesQuery, RatesQueryVariables> = {
  kind: 'Document',
  definitions: [
    {
      kind: 'OperationDefinition',
      operation: 'query',
      name: { ... }
    }
  ]
}

For information about the setup and usage of TypedDocumentNode, please refer to the library’s documentation.