Introspection

Installation

npm i -D @graphql-codegen/introspection

pnpm add -D @graphql-codegen/introspection

yarn add --dev @graphql-codegen/introspection

bun add --dev @graphql-codegen/introspection

This plugin generates a GraphQL introspection file based on your GraphQL schema.

Config API Reference

minify

type: boolean default: false

Set to true in order to minify the JSON output.

Usage Examples

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

 const config: CodegenConfig = {
 schema: 'https://localhost:4000/graphql',
 documents: ['src/**\/*.tsx'],
 generates: {
 'introspection.json': {
 plugins: ['introspection'],
 config: {
 minify: true
 },
 },
 },
 };
 export default config;

descriptions

type: boolean default: true

Whether to include descriptions in the introspection result.

specifiedByUrl

type: boolean default: false

Whether to include specifiedByUrl in the introspection result.

directiveIsRepeatable

type: boolean default: true

Whether to include isRepeatable flag on directives.

schemaDescription

type: boolean default: false

Whether to include description field on schema.

federation

type: boolean