@graphql-codegen/plugin-helpers

property 'apollo-engine'

'apollo-engine': ApolloEngineOptions;

property allowPartialOutputs

allowPartialOutputs?: boolean;

• If true, write to files whichever generates block succeeds. If false, one failed generates means no output is written to files. Default: false

property config

config?: PluginConfig;

• object true Configuration object containing key => value that will be passed to the plugins. Specifying configuration in this level of your configuration file will pass it to all plugins, in all outputs.

  The options may vary depends on what plugins you are using.

  For more details: https://graphql-code-generator.com/docs/config-reference/config-field

property customFetch

customFetch?: string | CustomSchemaFetcher;

• Specify a Node module name, a custom file, or a function, to be used instead of a standard fetch.

property debug

debug?: boolean;

• A flag to output debug logs

property documents

documents?: InstanceOrArray<OperationDocument>;

• A pointer(s) to your GraphQL documents: query, mutation, subscription and fragment. These documents will be loaded into for all your output files. You can use one of the following:

  - Path to a local .graphql file - Path to a code file (for example: .js or .tsx) containing GraphQL operation strings. - Glob expression pointing to multiple .graphql files - Glob expression pointing to multiple code files - Inline string containing GraphQL SDL operation definition

  You can specify either a single file, or multiple.

  For more details: https://graphql-code-generator.com/docs/config-reference/documents-field

property emitLegacyCommonJSImports

emitLegacyCommonJSImports?: boolean;

• Deprecated

  Please use importExtension instead. A flag to disable adding .js extension to the output file. Default: true.

property errorsOnly

errorsOnly?: boolean;

• A flag to print only errors.

property generates

generates: {
    [outputPath: string]: ConfiguredOutput | ConfiguredPlugin[];
};

• A map where the key represents an output path for the generated code and the value represents a set of options which are relevant for that specific file.

  For more details: https://graphql-code-generator.com/docs/config-reference/codegen-config

property hooks

hooks?: Partial<LifecycleHooksDefinition>;

• Specifies scripts to run when events are happening in the codegen core. Hooks defined on that level will effect all output files.

  For more details: https://graphql-code-generator.com/docs/config-reference/lifecycle-hooks

property ignoreNoDocuments

ignoreNoDocuments?: boolean;

• A flag to suppress non-zero exit code when there are no documents to generate.

property importExtension

importExtension?: '' | `.${string}`;

• Append this extension to all imports. Useful for ESM environments that require file extensions in import statements.

property noSilentErrors

noSilentErrors?: boolean;

• Alows to raise errors if any matched files are not valid GraphQL. Default: false.

property overwrite

overwrite?: boolean;

• A flag to overwrite files if they already exist when generating code (true by default).

  For more details: https://graphql-code-generator.com/docs/config-reference/codegen-config

property pluckConfig

pluckConfig?: {
    /**
     * @description An array of package name and identifier that will be used to track down your gql usages and imports. Use this if your code files imports gql from another library or you have a custom gql tag. identifier is the named export, so don't provide it if the tag function is imported as default.
     */
    modules?: Array<{
        /**
         * @description the name of the NPM package name you wish to look for
         */
        name: string;
        /**
         * @description the tag identifier name you wish to look for
         */
        identifier?: string;
    }>;
    /**
     * @description Configures the magic GraphQL comments to look for. The default is `GraphQL`.
     */
    gqlMagicComment?: string;
    /**
     * @description Overrides the name of the default GraphQL name identifier.
     */
    globalIdentifier?: string;
    /**
     * @description Allows to use a global identifier instead of a module import.
     */
    globalGqlIdentifierName?: string | string[];
};

• Allows you to override the configuration for @graphql-tools/graphql-tag-pluck, the tool that extracts your GraphQL operations from your code files.

  For more details: https://graphql-code-generator.com/docs/config-reference/documents-field#graphql-tag-pluck

property pluginContext

pluginContext?: {
    [key: string]: any;
};

• Additional context passed to plugins

property pluginLoader

pluginLoader?: PackageLoaderFn<CodegenPlugin>;

• If you are using the programmatic API in a browser environment, you can override this configuration to load your plugins in a way different than require.

property require

require?: RequireExtension;

• A path to a file which defines custom Node.JS require() handlers for custom file extensions. This is essential if the code generator has to go through files which require other files in an unsupported format (by default).

  For more details: https://graphql-code-generator.com/docs/config-reference/require-field See more information about require.extensions: https://gist.github.com/jamestalmage/df922691475cff66c7e6.

  Note: values that specified in your .yml file will get loaded after loading the config .yml file.

property schema

schema?: InstanceOrArray<Schema>;

• A pointer(s) to your GraphQL schema. This schema will be the base schema for all your outputs. You can use one of the following:

  - URL pointing to a GraphQL endpoint - Path to a local .json file - Path to a local .graphql file - Glob expression pointing to multiple .graphql files - Path to a local code file (for example: .js) that exports GraphQLSchema object - Inline string containing GraphQL SDL schema definition

  You can specify either a single schema, or multiple, and GraphQL Code Generator will merge the schemas into a single schema.

  For more details: https://graphql-code-generator.com/docs/config-reference/schema-field

property silent

silent?: boolean;

• A flag to suppress printing errors when they occur.

property verbose

verbose?: boolean;

• A flag to output more detailed information about tasks

property watch

watch?: boolean | string | string[];

• A flag to trigger codegen when there are changes in the specified GraphQL schemas.

  You can either specify a boolean to turn it on/off or specify an array of glob patterns to add custom files to the watch.

  For more details: https://graphql-code-generator.com/docs/getting-started/development-workflow#watch-mode

property config

config?: PluginConfig;

• Configuration object containing key => value that will be passed to the plugins. Specifying configuration in this level of your configuration file will pass it to all plugins, in all outputs.

  The options may vary depends on what plugins you are using.

  For more details: https://graphql-code-generator.com/docs/config-reference/config-field

property documents

documents?: InstanceOrArray<OperationDocument>;

• A pointer(s) to your GraphQL documents: query, mutation, subscription and fragment. These documents will be loaded into for all your output files. You can use one of the following:

  - Path to a local .graphql file - Path to a code file (for example: .js or .tsx) containing GraphQL operation strings. - Glob expression pointing to multiple .graphql files - Glob expression pointing to multiple code files - Inline string containing GraphQL SDL operation definition

  You can specify either a single file, or multiple.

  For more details: https://graphql-code-generator.com/docs/config-reference/documents-field

property documentTransforms

documentTransforms?: OutputDocumentTransform[];

• DocumentTransform changes documents before executing plugins.

property hooks

hooks?: Partial<LifecycleHooksDefinition>;

• Specifies scripts to run when events are happening in the codegen core. Hooks defined on that level will effect only the current output files.

  For more details: https://graphql-code-generator.com/docs/config-reference/lifecycle-hooks

property overwrite

overwrite?: boolean;

• A flag to overwrite files if they already exist when generating code (true by default).

  For more details: https://graphql-code-generator.com/docs/config-reference/codegen-config

property plugins

plugins?: OutputConfig[];

• array { "$ref": "#/definitions/GeneratedPluginsMap" } List of plugins to apply to this current output file.

  You can either specify plugins from the community using the NPM package name (after you installed it in your project), or you can use a path to a local file for custom plugins.

  You can find a list of available plugins here: https://the-guild.dev/graphql/codegen/docs/plugins/index Need a custom plugin? read this: https://the-guild.dev/graphql/codegen/docs/custom-codegen/index

property preset

preset?: PresetNames | OutputPreset;

• If your setup uses Preset to have a more dynamic setup and output, set the name of your preset here.

  Presets are a way to have more than one file output, for example: https://the-guild.dev/graphql/codegen/docs/presets/near-operation-file

  You can either specify a preset from the community using the NPM package name (after you installed it in your project), or you can use a path to a local file for a custom preset.

  List of available presets: https://graphql-code-generator.com/docs/presets/presets-index

property presetConfig

presetConfig?: {
    [key: string]: any;
};

• If your setup uses Preset to have a more dynamic setup and output, set the configuration object of your preset here.

  List of available presets: https://graphql-code-generator.com/docs/presets/presets-index

property schema

schema?: InstanceOrArray<Schema>;

• A pointer(s) to your GraphQL schema. This schema will be available only for this specific generates record. You can use one of the following:

  - URL pointing to a GraphQL endpoint - Path to a local .json file - Path to a local .graphql file - Glob expression pointing to multiple .graphql files - Path to a local code file (for example: .js) that exports GraphQLSchema object - Inline string containing GraphQL SDL schema definition

  You can specify either a single schema, or multiple, and GraphQL Code Generator will merge the schemas into a single schema.

  For more details: https://graphql-code-generator.com/docs/config-reference/schema-field

property watchPattern

watchPattern?: string | string[];

• @description: Additional file pattern to watch when using watch mode

index signature

[name: string]: PluginConfig;

index signature

[path: string]: CustomDocumentLoaderOptions;

property loader

loader: string;

• Specify a path to a custom code file (local or module) that will handle the documents loading.

property hash

hash?: string;

property config

config: {
    [key: string]: any;
};

property documents

documents: Types.DocumentFile[];

property documentTransforms

documentTransforms?: ConfiguredDocumentTransform[];

property emitLegacyCommonJSImports

emitLegacyCommonJSImports?: boolean;

property filename

filename: string;

property importExtension

importExtension?: '' | `.${string}`;

property pluginContext

pluginContext?: {
    [key: string]: any;
};

property pluginMap

pluginMap: {
    [name: string]: CodegenPlugin;
};

property plugins

plugins: Types.ConfiguredPlugin[];

property profiler

profiler?: Profiler;

property schema

schema: DocumentNode;

property schemaAst

schemaAst?: GraphQLSchema;

property skipDocumentsValidation

skipDocumentsValidation?: Types.SkipDocumentsValidationOptions;

method cache

cache: <T>(
    namespace: string,
    key: string,
    factory: () => Promise<T>
) => Promise<T>;

index signature

[githubProtocol: string]: {
    token: string;
};

property allowLegacySDLEmptyFields

allowLegacySDLEmptyFields?: boolean;

• If enabled, the parser will parse empty fields sets in the Schema Definition Language. Otherwise, the parser will follow the current specification.

  This option is provided to ease adoption of the final SDL specification and will be removed in v16.

  false

property allowLegacySDLImplementsInterfaces

allowLegacySDLImplementsInterfaces?: boolean;

• If enabled, the parser will parse implemented interfaces with no & character between each interface. Otherwise, the parser will follow the current specification.

  This option is provided to ease adoption of the final SDL specification and will be removed in v16.

  false

property assumeValidSDL

assumeValidSDL?: boolean;

• Set to true to assume the SDL is valid.

  false

property commentDescriptions

commentDescriptions?: boolean;

• Converts all GraphQL comments (# sign) to descriptions during the parse phase, to make it available for plugins later. false

property experimentalFragmentVariables

experimentalFragmentVariables?: boolean;

• EXPERIMENTAL:

  If enabled, the parser will understand and parse variable definitions contained in a fragment definition. They'll be represented in the variableDefinitions field of the FragmentDefinitionNode.

  The syntax is identical to normal, query-defined variables. For example:

  fragment A($var: Boolean = false) on T { ... }

  Note: this feature is experimental and may change or be removed in the future.

  false

property noLocation

noLocation?: boolean;

• By default, the parser creates AST nodes that know the location in the source that they correspond to. This configuration flag disables that behavior for performance or testing.

  false

property skipGraphQLImport

skipGraphQLImport?: boolean;

• Skips checks for graphql-import syntax and loads the file as-is, without imports support. true

index signature

[globPath: string]: LocalSchemaPathOptions;

index signature

[path: string]: SchemaFromCodeFileOptions;

property assumeValid

assumeValid?: boolean;

• Set this to true in order to tell codegen to skip documents validation.

property noPluck

noPluck?: boolean;

• Set this to true in order to tell codegen not to try to extract GraphQL AST strings schema/docs

property noRequire

noRequire?: boolean;

• Set this to true in order to tell codegen not to try to require files in order to find schema/docs

index signature

[pointer: string]: SchemaWithLoaderOptions;

property loader

loader: string;

• Specify a path to a custom code file (local or module) that will handle the schema loading.

property customFetch

customFetch?: string | CustomSchemaFetcher;

• Specify a Node module name, a custom file, or a function, to be used instead of a standard fetch.

property handleAsSDL

handleAsSDL?: boolean;

• Handling the response as SDL will allow you to load schema from remote server that doesn't return a JSON introspection.

property headers

headers?: {
    [headerName: string]: string;
};

• HTTP headers you wish to add to the HTTP request sent by codegen to fetch your GraphQL remote schema.

property method

method?: string;

• HTTP Method to use, either POST (default) or GET.

index signature

[url: string]: UrlSchemaOptions;