@graphql-codegen/introspection
- Version 5.0.0
- Published
- 7.3 kB
- 3 dependencies
- MIT license
Install
npm i @graphql-codegen/introspectionyarn add @graphql-codegen/introspectionpnpm add @graphql-codegen/introspectionOverview
GraphQL Code Generator plugin for generating an introspection JSON file for a GraphQLSchema
Index
Variables
Interfaces
interface IntrospectionPluginConfig
interface IntrospectionPluginConfig {}This plugin generates a GraphQL introspection file based on your GraphQL schema.
property descriptions
descriptions?: boolean;Whether to include descriptions in the introspection result. true
property directiveIsRepeatable
directiveIsRepeatable?: boolean;Whether to include
isRepeatableflag on directives. true
property federation
federation?: boolean;property minify
minify?: boolean;Set to
truein order to minify the JSON output. falseimport 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;
property schemaDescription
schemaDescription?: boolean;Whether to include
descriptionfield on schema. false
property specifiedByUrl
specifiedByUrl?: boolean;Whether to include
specifiedByUrlin the introspection result. false
Package Files (1)
Dependencies (3)
Dev Dependencies (0)
No dev dependencies.
Peer Dependencies (1)
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@graphql-codegen/introspection.
- Markdown[](https://www.jsdocs.io/package/@graphql-codegen/introspection)
- HTML<a href="https://www.jsdocs.io/package/@graphql-codegen/introspection"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 2776 ms. - Missing or incorrect documentation? Open an issue for this package.
