The Guild LogoThe Guild Monogram

Search docs

Search icon

Products by The Guild

Products

Hive logoHive blurred logo

Hive

Schema Registry for your GraphQL Workflows

Docs

GraphQL Code Generator

Generate anything from GraphQL schema / operations!

Contact Us

TypeScript Operations

yarn add @graphql-codegen/typescript-operations
Usage Requirements#

In order to use this GraphQL Codegen plugin, please make sure that you have GraphQL operations (query / mutation / subscription and fragment) set as documents: ... in your codegen.yml.

Without loading your GraphQL operations (query, mutation, subscription and fragment), you won't see any change in the generated output.

This plugin generates TypeScript types based on your GraphQLSchema and your GraphQL operations and fragments. It generates types for your GraphQL documents: Query, Mutation, Subscription and Fragment.

Note: In most configurations, this plugin requires you to use `typescript as well, because it depends on its base types.

Config API Reference#

arrayInputCoercion

type: boolean default: true

The [GraphQL spec]{@link https ://spec.graphql.org/draft/#sel-FAHjBJFCAACE_Gh7d}allows arrays and a single primitive value for list input. This allows to deactivate that behavior to only accept arrays instead of single values. If set to false, the definition: query foo(bar: [Int!]!): Foo will output bar: Array<Int> instead of bar: Array<Int> | Int for the variable part.

Usage Examples#

generates: path/to/file.ts: plugins: - typescript config: arrayInputCoercion: false
avoidOptionals

type: AvoidOptionalsConfig | boolean default: false

This will cause the generator to avoid using TypeScript optionals (?) on types, so the following definition: type A { myField: String } will output myField: Maybe<string> instead of myField?: Maybe<string>.

Usage Examples#

Override all definition types#
generates: path/to/file.ts: plugins: - typescript - typescript-operations config: avoidOptionals: true
Override only specific definition types#
generates: path/to/file.ts: plugins: - typescript config: avoidOptionals: field: true inputValue: true object: true defaultValue: true
immutableTypes

type: boolean default: false

Generates immutable types by adding readonly to properties and uses ReadonlyArray.

Usage Examples#

generates: path/to/file.ts: plugins: - typescript - typescript-operations config: immutableTypes: true
flattenGeneratedTypes

type: boolean default: false

Flatten fragment spread and inline fragments into a simple selection set before generating.

Usage Examples#

generates: path/to/file.ts: plugins: - typescript - typescript-operations config: flattenGeneratedTypes: true
noExport

type: boolean default: false

Set to true in order to generate output without export modifier. This is useful if you are generating .d.ts file and want it to be globally available.

Usage Examples#

generates: path/to/file.ts: plugins: - typescript config: noExport: true
globalNamespace

type: boolean

addOperationExport

type: boolean default: false

Add const export of the operation name to output file. Pay attention that the file should be d.ts. You can combine it with near-operation-file preset and therefore the types will be generated along with graphql file. Then you need to set extension in presetConfig to be .gql.d.ts and by that you can import gql file in ts files. It will allow you to get everything with one import:

import { GetClient, GetClientQuery, GetClientQueryVariables } from './GetClient.gql'
maybeValue

type: string default: T | null

Allow to override the type value of Maybe.

Usage Examples#

Allow undefined#
generates: path/to/file.ts: plugins: - typescript config: maybeValue: T | null | undefined
Allow null in resolvers:#
generates: path/to/file.ts: plugins: - typescript - typescript-resolvers config: maybeValue: 'T extends PromiseLike<infer U> ? Promise<U | null> : T | null'
preResolveTypes

type: boolean default: true

Uses primitive types where possible. Set to false in order to use Pick and take use the types generated by typescript plugin.

Usage Examples#

plugins config: preResolveTypes: false
skipTypeNameForRoot

type: boolean default: false

Avoid adding __typename for root types. This is ignored when a selection explicitly specifies __typename.

Usage Examples#

plugins config: skipTypeNameForRoot: true
operationResultSuffix

type: string default: (empty)

Adds a suffix to generated operation result type names

dedupeOperationSuffix

type: boolean default: false

Set this configuration to true if you wish to make sure to remove duplicate operation name suffix.

omitOperationSuffix

type: boolean default: false

Set this configuration to true if you wish to disable auto add suffix of operation name, like Query, Mutation, Subscription, Fragment.

exportFragmentSpreadSubTypes

type: boolean default: false

If set to true, it will export the sub-types created in order to make it easier to access fields declared under fragment spread.

experimentalFragmentVariables

type: boolean default: false

If set to true, it will enable support for parsing variables on fragments.

addUnderscoreToArgsType

type: boolean

Adds _ to generated Args types in order to avoid duplicate identifiers.

Usage Examples#

With Custom Values#
config: addUnderscoreToArgsType: true
enumValues

type: EnumValuesMap

Overrides the default value of enum values declared in your GraphQL schema. You can also map the entire enum to an external type by providing a string that of module#type.

declarationKind

type: DeclarationKindConfig | string (values: abstract class, class, interface, type)

Overrides the default output for various GraphQL elements.

Usage Examples#

Override all declarations#
config: declarationKind: 'interface'
Override only specific declarations#
config: declarationKind: type: 'interface' input: 'interface'
enumPrefix

type: boolean default: true

Allow you to disable prefixing for generated enums, works in combination with typesPrefix.

Usage Examples#

Disable enum prefixes#
config: typesPrefix: I enumPrefix: false
fieldWrapperValue

type: string default: T

Allow you to add wrapper for field type, use T as the generic value. Make sure to set wrapFieldDefinitions to true in order to make this flag work.

Usage Examples#

Allow Promise#
generates: path/to/file.ts: plugins: - typescript config: wrapFieldDefinitions: true fieldWrapperValue: T | Promise<T>
wrapFieldDefinitions

type: boolean default: false

Set to true in order to wrap field definitions with FieldWrapper. This is useful to allow return types such as Promises and functions.

Usage Examples#

Enable wrapping fields#
generates: path/to/file.ts: plugins: - typescript config: wrapFieldDefinitions: true
onlyOperationTypes

type: boolean default: false

This will cause the generator to emit types for operations only (basically only enums and scalars)

Usage Examples#

Override all definition types#
generates: path/to/file.ts: plugins: - typescript config: onlyOperationTypes: true
ignoreEnumValuesFromSchema

type: boolean default: false

This will cause the generator to ignore enum values defined in GraphQLSchema

Usage Examples#

Ignore enum values from schema#
generates: path/to/file.ts: plugins: - typescript config: ignoreEnumValuesFromSchema: true
wrapEntireFieldDefinitions

type: boolean default: true

Set to true in order to wrap field definitions with EntireFieldWrapper. This is useful to allow return types such as Promises and functions for fields. Differs from wrapFieldDefinitions in that this wraps the entire field definition if i.e. the field is an Array, while wrapFieldDefinitions will wrap every single value inside the array.

entireFieldWrapperValue

type: string default: T | Promise<T> | (() => T | Promise<T>)

Allow to override the type value of EntireFieldWrapper. This wrapper applies outside of Array and Maybe unlike fieldWrapperValue, that will wrap the inner type.

directiveArgumentAndInputFieldMappings

type: DirectiveArgumentAndInputFieldMappings

Replaces a GraphQL scalar with a custom type based on the applied directive on an argument or input field.

You can use both module#type and module#namespace#type syntax. Will NOT work with introspected schemas since directives are not exported. Only works with directives on ARGUMENT_DEFINITION or INPUT_FIELD_DEFINITION.

WARNING: Using this option does only change the type definitions.

For actually ensuring that a type is correct at runtime you will have to use schema transforms (e.g. with @graphql-tools/utils mapSchema) that apply those rules! Otherwise, you might end up with a runtime type mismatch which could cause unnoticed bugs or runtime errors.

Please use this configuration option with care!

directiveArgumentAndInputFieldMappingTypeSuffix

type: string

Adds a suffix to the imported names to prevent name clashes.

Usage Examples#

plugins: config: directiveArgumentAndInputFieldMappingTypeSuffix: Model
strictScalars

type: boolean default: false

Makes scalars strict.

If scalars are found in the schema that are not defined in scalars an error will be thrown during codegen.

Usage Examples#

config: strictScalars: true
defaultScalarType

type: string default: any

Allows you to override the type that unknown scalars will have.

Usage Examples#

config: defaultScalarType: unknown
scalars

type: ScalarsMap

Extends or overrides the built-in scalars and custom GraphQL scalars to a custom type.

namingConvention

type: NamingConvention default: change-case-all#pascalCase

Allow you to override the naming convention of the output. You can either override all namings, or specify an object with specific custom naming convention per output. The format of the converter must be a valid module#method. Allowed values for specific output are: typeNames, enumValues. You can also use "keep" to keep all GraphQL names as-is. Additionally, you can set transformUnderscore to true if you want to override the default behavior, which is to preserve underscores.

Available case functions in change-case-all are camelCase, capitalCase, constantCase, dotCase, headerCase, noCase, paramCase, pascalCase, pathCase, sentenceCase, snakeCase, lowerCase, localeLowerCase, lowerCaseFirst, spongeCase, titleCase, upperCase, localeUpperCase and upperCaseFirst See more

typesPrefix

type: string default: (empty)

Prefixes all the generated types.

Usage Examples#

config: typesPrefix: I
typesSuffix

type: string default: (empty)

Suffixes all the generated types.

Usage Examples#

config: typesSuffix: I
skipTypename

type: boolean default: false

Does not add __typename to the generated types, unless it was specified in the selection set.

Usage Examples#

config: skipTypename: true
nonOptionalTypename

type: boolean default: false

Automatically adds __typename field to the generated types, even when they are not specified in the selection set, and makes it non-optional

Usage Examples#

config: nonOptionalTypename: true
useTypeImports

type: boolean default: false

Will use import type {} rather than import {} when importing only types. This gives compatibility with TypeScript's "importsNotUsedAsValues": "error" option

dedupeFragments

type: boolean default: false

Removes fragment duplicates for reducing data transfer. It is done by removing sub-fragments imports from fragment definition Instead - all of them are imported to the Operation node.

inlineFragmentTypes

type: InlineFragmentTypeOptions default: inline

Whether fragment types should be inlined into other operations. "inline" is the default behavior and will perform deep inlining fragment types within operation type definitions. "combine" is the previous behavior that uses fragment type references without inlining the types (and might cause issues with deeply nested fragment that uses list types).

Package Details