Introspection
Package name | Weekly Downloads | Version | License | Updated |
---|---|---|---|---|
@graphql-codegen/introspection | Dec 7th, 2022 |
Installation
yarn add -D @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
codegen.ts
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
Last updated on August 10, 2022