Language - Graphql Js

import { ApiSignature, ApiType } from '../../components/ApiCode';

Parse, print, and visit GraphQL language source files and AST nodes.

These exports are also available from the root graphql package.

For documentation purposes, these exports are grouped into the following categories:

Category: AST

<div className="api-category-toc"> <p> <strong>Classes:</strong>

<a href="/api-v17/language#location">Location</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#token">Token</a>

</p> <p> <strong>Types:</strong>

<a href="/api-v17/language#astnode">ASTNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#astkindtonode">ASTKindToNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#namenode">NameNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#documentnode">DocumentNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#definitionnode">DefinitionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#executabledefinitionnode">ExecutableDefinitionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#operationdefinitionnode">OperationDefinitionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#subscriptionoperationdefinitionnode">SubscriptionOperationDefinitionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#variabledefinitionnode">VariableDefinitionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#variablenode">VariableNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#selectionsetnode">SelectionSetNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#selectionnode">SelectionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#fieldnode">FieldNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#argumentnode">ArgumentNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#constargumentnode">ConstArgumentNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#fragmentargumentnode">FragmentArgumentNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#fragmentspreadnode">FragmentSpreadNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#inlinefragmentnode">InlineFragmentNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#fragmentdefinitionnode">FragmentDefinitionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#valuenode">ValueNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#constvaluenode">ConstValueNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#intvaluenode">IntValueNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#floatvaluenode">FloatValueNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#stringvaluenode">StringValueNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#booleanvaluenode">BooleanValueNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#nullvaluenode">NullValueNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#enumvaluenode">EnumValueNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#listvaluenode">ListValueNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#constlistvaluenode">ConstListValueNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#objectvaluenode">ObjectValueNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#constobjectvaluenode">ConstObjectValueNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#objectfieldnode">ObjectFieldNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#constobjectfieldnode">ConstObjectFieldNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#directivenode">DirectiveNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#constdirectivenode">ConstDirectiveNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#typenode">TypeNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#namedtypenode">NamedTypeNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#listtypenode">ListTypeNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#nonnulltypenode">NonNullTypeNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#typesystemdefinitionnode">TypeSystemDefinitionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#schemadefinitionnode">SchemaDefinitionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#operationtypedefinitionnode">OperationTypeDefinitionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#typedefinitionnode">TypeDefinitionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#scalartypedefinitionnode">ScalarTypeDefinitionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#objecttypedefinitionnode">ObjectTypeDefinitionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#fielddefinitionnode">FieldDefinitionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#inputvaluedefinitionnode">InputValueDefinitionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#interfacetypedefinitionnode">InterfaceTypeDefinitionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#uniontypedefinitionnode">UnionTypeDefinitionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#enumtypedefinitionnode">EnumTypeDefinitionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#enumvaluedefinitionnode">EnumValueDefinitionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#inputobjecttypedefinitionnode">InputObjectTypeDefinitionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#directivedefinitionnode">DirectiveDefinitionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#typesystemextensionnode">TypeSystemExtensionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#schemaextensionnode">SchemaExtensionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#typeextensionnode">TypeExtensionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#scalartypeextensionnode">ScalarTypeExtensionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#objecttypeextensionnode">ObjectTypeExtensionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#interfacetypeextensionnode">InterfaceTypeExtensionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#uniontypeextensionnode">UnionTypeExtensionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#enumtypeextensionnode">EnumTypeExtensionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#inputobjecttypeextensionnode">InputObjectTypeExtensionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#directiveextensionnode">DirectiveExtensionNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#schemacoordinatenode">SchemaCoordinateNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#typecoordinatenode">TypeCoordinateNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#membercoordinatenode">MemberCoordinateNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#argumentcoordinatenode">ArgumentCoordinateNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#directivecoordinatenode">DirectiveCoordinateNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#directiveargumentcoordinatenode">DirectiveArgumentCoordinateNode</a>

</p> </div>

Classes

Location

Contains a range of UTF-8 character offsets and token references that identify the region of the source from which the AST derived.

Constructor

Creates a Location instance.

Signature:

Members

<table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>start</td> <td><ApiType parts={[["keyword", "number"]]} /></td> <td>The character offset at which this Node begins.</td> </tr> <tr> <td>end</td> <td><ApiType parts={[["keyword", "number"]]} /></td> <td>The character offset at which this Node ends.</td> </tr> <tr> <td>startToken</td> <td><ApiType parts={[["link", "Token", "/api-v17/language#token"]]} /></td> <td>The Token at which this Node begins.</td> </tr> <tr> <td>endToken</td> <td><ApiType parts={[["link", "Token", "/api-v17/language#token"]]} /></td> <td>The Token at which this Node ends.</td> </tr> <tr> <td>source</td> <td><ApiType parts={[["link", "Source", "/api-v17/language#source"]]} /></td> <td>The Source document the AST represents.</td> </tr> </tbody> </table> <hr className="api-subsection-divider" />

toJSON()

Returns a JSON representation of this location.

Signature:

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Returns</div> <table> <thead> <tr> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><ApiType parts={["\u007b ", ["property", "start"], ": ", ["keyword", "number"], "; ", ["property", "end"], ": ", ["keyword", "number"], " \u007d"]} /></td> <td>The JSON-serializable representation.</td> </tr> </tbody> </table> <hr className="api-subsection-divider" /> <div className="api-subsection-title">Example</div>

import { parse } from 'graphql/language';

const document = parse('{ hello }');
const location = document.loc?.toJSON();

location; // => { start: 0, end: 9 }

Token

Represents a range of characters represented by a lexical token within a Source.

Constructor

Creates a Token instance.

Signature:

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Arguments</div> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>kind</td> <td><ApiType parts={[["link", "TokenKind", "/api-v17/language#tokenkind"]]} /></td> <td>Token kind produced by lexical analysis.</td> </tr> <tr> <td>start</td> <td><ApiType parts={[["keyword", "number"]]} /></td> <td>Character offset where this token begins.</td> </tr> <tr> <td>end</td> <td><ApiType parts={[["keyword", "number"]]} /></td> <td>Character offset where this token ends.</td> </tr> <tr> <td>line</td> <td><ApiType parts={[["keyword", "number"]]} /></td> <td>One-indexed line number where this token begins.</td> </tr> <tr> <td>column</td> <td><ApiType parts={[["keyword", "number"]]} /></td> <td>One-indexed column number where this token begins.</td> </tr> <tr> <td>value?</td> <td><ApiType parts={[["keyword", "string"]]} /></td> <td>Interpreted value for non-punctuation tokens.</td> </tr> </tbody> </table> <hr className="api-subsection-divider" />

Members

<table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>kind</td> <td><ApiType parts={[["link", "TokenKind", "/api-v17/language#tokenkind"]]} /></td> <td>The kind of Token.</td> </tr> <tr> <td>start</td> <td><ApiType parts={[["keyword", "number"]]} /></td> <td>The character offset at which this Node begins.</td> </tr> <tr> <td>end</td> <td><ApiType parts={[["keyword", "number"]]} /></td> <td>The character offset at which this Node ends.</td> </tr> <tr> <td>line</td> <td><ApiType parts={[["keyword", "number"]]} /></td> <td>The 1-indexed line number on which this Token appears.</td> </tr> <tr> <td>column</td> <td><ApiType parts={[["keyword", "number"]]} /></td> <td>The 1-indexed column number at which this Token begins.</td> </tr> <tr> <td>value</td> <td><ApiType parts={[["keyword", "string"]]} /></td> <td>For non-punctuation tokens, represents the interpreted value of the token.

Note: is undefined for punctuation tokens, but typed as string for

convenience in the parser.</td> </tr> <tr> <td>prev</td> <td><ApiType parts={[["link", "Token", "/api-v17/language#token"], " \u007c ", ["keyword", "null"]]} /></td> <td>Tokens exist as nodes in a double-linked-list amongst all tokens

including ignored tokens. <SOF> is always the first node and <EOF>

the last.</td> </tr> <tr> <td>next</td> <td><ApiType parts={[["link", "Token", "/api-v17/language#token"], " \u007c ", ["keyword", "null"]]} /></td> <td>Next token in the token stream, including ignored tokens.</td> </tr>

</tbody> </table> <hr className="api-subsection-divider" />

toJSON()

Returns a JSON representation of this token.

Signature:

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Returns</div> <table> <thead> <tr> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><ApiType parts={["\u007b\n ", ["property", "kind"], ": ", ["link", "TokenKind", "/api-v17/language#tokenkind"], ";\n ", ["property", "value"], "?: ", ["keyword", "string"], ";\n ", ["property", "line"], ": ", ["keyword", "number"], ";\n ", ["property", "column"], ": ", ["keyword", "number"], ";\n\u007d"]} /></td> <td>The JSON-serializable representation.</td> </tr> </tbody> </table> <hr className="api-subsection-divider" /> <div className="api-subsection-title">Example</div>

import { Lexer, Source } from 'graphql/language';

const lexer = new Lexer(new Source('{ hello }'));
const token = lexer.advance().toJSON();

token; // => { kind: '{', value: undefined, line: 1, column: 1 }

Types

ASTNode

Type alias. The list of all possible AST node types.

ASTKindToNode

Type alias. Utility type listing all nodes indexed by their kind.

NameNode

Interface. An identifier in a GraphQL document.

DocumentNode

Interface. The root AST node for a parsed GraphQL document.

DefinitionNode

Type alias. Any top-level definition that may appear in a GraphQL document.

ExecutableDefinitionNode

Type alias. Any executable definition that may appear in an operation document.

OperationDefinitionNode

Interface. A query, mutation, or subscription operation definition.

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Members</div> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>kind</td> <td><ApiType parts={[["literal", "'OperationDefinition'"]]} /></td> <td>The discriminator identifying the concrete AST or introspection kind.</td> </tr> <tr> <td>loc?</td> <td><ApiType parts={[["link", "Location", "/api-v17/language#location"]]} /></td> <td>The source location for this AST node, if location tracking was enabled.</td> </tr> <tr> <td>description?</td> <td><ApiType parts={[["link", "StringValueNode", "/api-v17/language#stringvaluenode"]]} /></td> <td>The optional GraphQL description associated with this definition.</td> </tr> <tr> <td>operation</td> <td><ApiType parts={[["link", "OperationTypeNode", "/api-v17/language#operationtypenode"]]} /></td> <td>The operation selected for execution.</td> </tr> <tr> <td>name?</td> <td><ApiType parts={[["link", "NameNode", "/api-v17/language#namenode"]]} /></td> <td>Name node identifying this AST node.</td> </tr> <tr> <td>variableDefinitions?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "VariableDefinitionNode", "/api-v17/language#variabledefinitionnode"], "[]"]} /></td> <td>Variable definitions declared by this operation or fragment.</td> </tr> <tr> <td>directives?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "DirectiveNode", "/api-v17/language#directivenode"], "[]"]} /></td> <td>Directives available in this schema or applied to this AST node.</td> </tr> <tr> <td>selectionSet</td> <td><ApiType parts={[["link", "SelectionSetNode", "/api-v17/language#selectionsetnode"]]} /></td> <td>Selections made by this operation, field, or fragment.</td> </tr> </tbody> </table> <hr className="api-item-divider" />

SubscriptionOperationDefinitionNode

Interface. A narrowed OperationDefinitionNode for subscription operations. Subscription operations go through a distinct execution pipeline (source event stream + per-event execution), so narrowing the operation type allows functions in that pipeline to accept only valid input.

VariableDefinitionNode

Interface. A variable declaration in an operation or experimental fragment definition.

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Members</div> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>kind</td> <td><ApiType parts={[["literal", "'VariableDefinition'"]]} /></td> <td>The discriminator identifying the concrete AST or introspection kind.</td> </tr> <tr> <td>loc?</td> <td><ApiType parts={[["link", "Location", "/api-v17/language#location"]]} /></td> <td>The source location for this AST node, if location tracking was enabled.</td> </tr> <tr> <td>description?</td> <td><ApiType parts={[["link", "StringValueNode", "/api-v17/language#stringvaluenode"]]} /></td> <td>The optional GraphQL description associated with this definition.</td> </tr> <tr> <td>variable</td> <td><ApiType parts={[["link", "VariableNode", "/api-v17/language#variablenode"]]} /></td> <td>The variable being defined or referenced.</td> </tr> <tr> <td>type</td> <td><ApiType parts={[["link", "TypeNode", "/api-v17/language#typenode"]]} /></td> <td>The GraphQL type reference or runtime type for this element.</td> </tr> <tr> <td>defaultValue?</td> <td><ApiType parts={[["link", "ConstValueNode", "/api-v17/language#constvaluenode"]]} /></td> <td>Default value used when no explicit value is supplied.</td> </tr> <tr> <td>directives?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "ConstDirectiveNode", "/api-v17/language#constdirectivenode"], "[]"]} /></td> <td>Directives available in this schema or applied to this AST node.</td> </tr> </tbody> </table> <hr className="api-item-divider" />

VariableNode

Interface. A variable reference, such as $id.

SelectionSetNode

Interface. A set of fields and fragments selected from an object, interface, or union.

SelectionNode

Type alias. Any selection that may appear inside a selection set.

FieldNode

Interface. A field selected in an executable GraphQL document.

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Members</div> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>kind</td> <td><ApiType parts={[["literal", "'Field'"]]} /></td> <td>The discriminator identifying the concrete AST or introspection kind.</td> </tr> <tr> <td>loc?</td> <td><ApiType parts={[["link", "Location", "/api-v17/language#location"]]} /></td> <td>The source location for this AST node, if location tracking was enabled.</td> </tr> <tr> <td>alias?</td> <td><ApiType parts={[["link", "NameNode", "/api-v17/language#namenode"]]} /></td> <td>The response-key alias for this field, if one was supplied.</td> </tr> <tr> <td>name</td> <td><ApiType parts={[["link", "NameNode", "/api-v17/language#namenode"]]} /></td> <td>Name node identifying this AST node.</td> </tr> <tr> <td>arguments?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "ArgumentNode", "/api-v17/language#argumentnode"], "[]"]} /></td> <td>Arguments supplied to this field, directive, or coordinate.</td> </tr> <tr> <td>directives?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "DirectiveNode", "/api-v17/language#directivenode"], "[]"]} /></td> <td>Directives available in this schema or applied to this AST node.</td> </tr> <tr> <td>selectionSet?</td> <td><ApiType parts={[["link", "SelectionSetNode", "/api-v17/language#selectionsetnode"]]} /></td> <td>Selections made by this operation, field, or fragment.</td> </tr> </tbody> </table> <hr className="api-item-divider" />

ArgumentNode

Interface. An argument supplied to a field or directive.

ConstArgumentNode

Interface. An argument node whose value is guaranteed to be constant.

FragmentArgumentNode

Interface. Variable definition declared by a fragment argument.

FragmentSpreadNode

Interface. A named fragment spread, such as ...userFields.

InlineFragmentNode

Interface. An inline fragment spread with an optional type condition.

FragmentDefinitionNode

Interface. A reusable fragment definition declared in an executable document.

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Members</div> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>kind</td> <td><ApiType parts={[["literal", "'FragmentDefinition'"]]} /></td> <td>The discriminator identifying the concrete AST or introspection kind.</td> </tr> <tr> <td>loc?</td> <td><ApiType parts={[["link", "Location", "/api-v17/language#location"]]} /></td> <td>The source location for this AST node, if location tracking was enabled.</td> </tr> <tr> <td>description?</td> <td><ApiType parts={[["link", "StringValueNode", "/api-v17/language#stringvaluenode"]]} /></td> <td>The optional GraphQL description associated with this definition.</td> </tr> <tr> <td>name</td> <td><ApiType parts={[["link", "NameNode", "/api-v17/language#namenode"]]} /></td> <td>Name node identifying this AST node.</td> </tr> <tr> <td>variableDefinitions?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "VariableDefinitionNode", "/api-v17/language#variabledefinitionnode"], "[]"]} /></td> <td>Experimental variable definitions declared by this fragment definition.</td> </tr> <tr> <td>typeCondition</td> <td><ApiType parts={[["link", "NamedTypeNode", "/api-v17/language#namedtypenode"]]} /></td> <td>The type condition that limits where this fragment applies.</td> </tr> <tr> <td>directives?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "DirectiveNode", "/api-v17/language#directivenode"], "[]"]} /></td> <td>Directives available in this schema or applied to this AST node.</td> </tr> <tr> <td>selectionSet</td> <td><ApiType parts={[["link", "SelectionSetNode", "/api-v17/language#selectionsetnode"]]} /></td> <td>Selections made by this operation, field, or fragment.</td> </tr> </tbody> </table> <hr className="api-item-divider" />

ValueNode

Type alias. Any value literal that may appear in an executable GraphQL document.

ConstValueNode

Type alias. Any value literal that is guaranteed not to contain a variable reference.

IntValueNode

Interface. An integer value literal.

FloatValueNode

Interface. A floating-point value literal.

StringValueNode

Interface. A string value literal.

BooleanValueNode

Interface. A boolean value literal.

NullValueNode

Interface. A null value literal.

EnumValueNode

Interface. An enum value literal.

ListValueNode

Interface. A list value literal.

ConstListValueNode

Interface. A list value literal whose elements are all constant values.

ObjectValueNode

Interface. An input object value literal.

ConstObjectValueNode

Interface. An input object value literal whose fields are all constant values.

ObjectFieldNode

Interface. A field inside an input object value literal.

ConstObjectFieldNode

Interface. A field inside a constant input object value literal.

DirectiveNode

Interface. A directive applied to an executable or type-system location.

ConstDirectiveNode

Interface. A directive whose arguments are all constant values.

TypeNode

Type alias. Any GraphQL type reference AST node.

NamedTypeNode

Interface. A named type reference.

ListTypeNode

Interface. A list type reference.

NonNullTypeNode

Interface. A non-null type reference.

TypeSystemDefinitionNode

Type alias. Any type-system definition that may appear in a schema document.

SchemaDefinitionNode

Interface. A schema definition in a type-system document.

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Members</div> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>kind</td> <td><ApiType parts={[["literal", "'SchemaDefinition'"]]} /></td> <td>The discriminator identifying the concrete AST or introspection kind.</td> </tr> <tr> <td>loc?</td> <td><ApiType parts={[["link", "Location", "/api-v17/language#location"]]} /></td> <td>The source location for this AST node, if location tracking was enabled.</td> </tr> <tr> <td>description?</td> <td><ApiType parts={[["link", "StringValueNode", "/api-v17/language#stringvaluenode"]]} /></td> <td>The optional GraphQL description associated with this definition.</td> </tr> <tr> <td>directives?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "ConstDirectiveNode", "/api-v17/language#constdirectivenode"], "[]"]} /></td> <td>Directives available in this schema or applied to this AST node.</td> </tr> <tr> <td>operationTypes</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "OperationTypeDefinitionNode", "/api-v17/language#operationtypedefinitionnode"], "[]"]} /></td> <td>Root operation types declared by this schema definition or extension.</td> </tr> </tbody> </table> <hr className="api-item-divider" />

OperationTypeDefinitionNode

Interface. A root operation type declaration inside a schema definition or extension.

TypeDefinitionNode

Type alias. Any named type definition that may appear in a schema document.

ScalarTypeDefinitionNode

Interface. A scalar type definition in a type-system document.

ObjectTypeDefinitionNode

Interface. An object type definition in a type-system document.

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Members</div> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>kind</td> <td><ApiType parts={[["literal", "'ObjectTypeDefinition'"]]} /></td> <td>The discriminator identifying the concrete AST or introspection kind.</td> </tr> <tr> <td>loc?</td> <td><ApiType parts={[["link", "Location", "/api-v17/language#location"]]} /></td> <td>The source location for this AST node, if location tracking was enabled.</td> </tr> <tr> <td>description?</td> <td><ApiType parts={[["link", "StringValueNode", "/api-v17/language#stringvaluenode"]]} /></td> <td>The optional GraphQL description associated with this definition.</td> </tr> <tr> <td>name</td> <td><ApiType parts={[["link", "NameNode", "/api-v17/language#namenode"]]} /></td> <td>Name node identifying this AST node.</td> </tr> <tr> <td>interfaces?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "NamedTypeNode", "/api-v17/language#namedtypenode"], "[]"]} /></td> <td>Interfaces implemented by this object or interface type.</td> </tr> <tr> <td>directives?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "ConstDirectiveNode", "/api-v17/language#constdirectivenode"], "[]"]} /></td> <td>Directives available in this schema or applied to this AST node.</td> </tr> <tr> <td>fields?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "FieldDefinitionNode", "/api-v17/language#fielddefinitionnode"], "[]"]} /></td> <td>Fields declared by this object, interface, input object, or literal.</td> </tr> </tbody> </table> <hr className="api-item-divider" />

FieldDefinitionNode

Interface. A field definition declared by an object or interface type.

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Members</div> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>kind</td> <td><ApiType parts={[["literal", "'FieldDefinition'"]]} /></td> <td>The discriminator identifying the concrete AST or introspection kind.</td> </tr> <tr> <td>loc?</td> <td><ApiType parts={[["link", "Location", "/api-v17/language#location"]]} /></td> <td>The source location for this AST node, if location tracking was enabled.</td> </tr> <tr> <td>description?</td> <td><ApiType parts={[["link", "StringValueNode", "/api-v17/language#stringvaluenode"]]} /></td> <td>The optional GraphQL description associated with this definition.</td> </tr> <tr> <td>name</td> <td><ApiType parts={[["link", "NameNode", "/api-v17/language#namenode"]]} /></td> <td>Name node identifying this AST node.</td> </tr> <tr> <td>arguments?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "InputValueDefinitionNode", "/api-v17/language#inputvaluedefinitionnode"], "[]"]} /></td> <td>Arguments supplied to this field, directive, or coordinate.</td> </tr> <tr> <td>type</td> <td><ApiType parts={[["link", "TypeNode", "/api-v17/language#typenode"]]} /></td> <td>The GraphQL type reference or runtime type for this element.</td> </tr> <tr> <td>directives?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "ConstDirectiveNode", "/api-v17/language#constdirectivenode"], "[]"]} /></td> <td>Directives available in this schema or applied to this AST node.</td> </tr> </tbody> </table> <hr className="api-item-divider" />

InputValueDefinitionNode

Interface. An argument or input-field definition.

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Members</div> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>kind</td> <td><ApiType parts={[["literal", "'InputValueDefinition'"]]} /></td> <td>The discriminator identifying the concrete AST or introspection kind.</td> </tr> <tr> <td>loc?</td> <td><ApiType parts={[["link", "Location", "/api-v17/language#location"]]} /></td> <td>The source location for this AST node, if location tracking was enabled.</td> </tr> <tr> <td>description?</td> <td><ApiType parts={[["link", "StringValueNode", "/api-v17/language#stringvaluenode"]]} /></td> <td>The optional GraphQL description associated with this definition.</td> </tr> <tr> <td>name</td> <td><ApiType parts={[["link", "NameNode", "/api-v17/language#namenode"]]} /></td> <td>Name node identifying this AST node.</td> </tr> <tr> <td>type</td> <td><ApiType parts={[["link", "TypeNode", "/api-v17/language#typenode"]]} /></td> <td>The GraphQL type reference or runtime type for this element.</td> </tr> <tr> <td>defaultValue?</td> <td><ApiType parts={[["link", "ConstValueNode", "/api-v17/language#constvaluenode"]]} /></td> <td>Default value used when no explicit value is supplied.</td> </tr> <tr> <td>directives?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "ConstDirectiveNode", "/api-v17/language#constdirectivenode"], "[]"]} /></td> <td>Directives available in this schema or applied to this AST node.</td> </tr> </tbody> </table> <hr className="api-item-divider" />

InterfaceTypeDefinitionNode

Interface. An interface type definition in a type-system document.

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Members</div> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>kind</td> <td><ApiType parts={[["literal", "'InterfaceTypeDefinition'"]]} /></td> <td>The discriminator identifying the concrete AST or introspection kind.</td> </tr> <tr> <td>loc?</td> <td><ApiType parts={[["link", "Location", "/api-v17/language#location"]]} /></td> <td>The source location for this AST node, if location tracking was enabled.</td> </tr> <tr> <td>description?</td> <td><ApiType parts={[["link", "StringValueNode", "/api-v17/language#stringvaluenode"]]} /></td> <td>The optional GraphQL description associated with this definition.</td> </tr> <tr> <td>name</td> <td><ApiType parts={[["link", "NameNode", "/api-v17/language#namenode"]]} /></td> <td>Name node identifying this AST node.</td> </tr> <tr> <td>interfaces?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "NamedTypeNode", "/api-v17/language#namedtypenode"], "[]"]} /></td> <td>Interfaces implemented by this object or interface type.</td> </tr> <tr> <td>directives?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "ConstDirectiveNode", "/api-v17/language#constdirectivenode"], "[]"]} /></td> <td>Directives available in this schema or applied to this AST node.</td> </tr> <tr> <td>fields?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "FieldDefinitionNode", "/api-v17/language#fielddefinitionnode"], "[]"]} /></td> <td>Fields declared by this object, interface, input object, or literal.</td> </tr> </tbody> </table> <hr className="api-item-divider" />

UnionTypeDefinitionNode

Interface. A union type definition in a type-system document.

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Members</div> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>kind</td> <td><ApiType parts={[["literal", "'UnionTypeDefinition'"]]} /></td> <td>The discriminator identifying the concrete AST or introspection kind.</td> </tr> <tr> <td>loc?</td> <td><ApiType parts={[["link", "Location", "/api-v17/language#location"]]} /></td> <td>The source location for this AST node, if location tracking was enabled.</td> </tr> <tr> <td>description?</td> <td><ApiType parts={[["link", "StringValueNode", "/api-v17/language#stringvaluenode"]]} /></td> <td>The optional GraphQL description associated with this definition.</td> </tr> <tr> <td>name</td> <td><ApiType parts={[["link", "NameNode", "/api-v17/language#namenode"]]} /></td> <td>Name node identifying this AST node.</td> </tr> <tr> <td>directives?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "ConstDirectiveNode", "/api-v17/language#constdirectivenode"], "[]"]} /></td> <td>Directives available in this schema or applied to this AST node.</td> </tr> <tr> <td>types?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "NamedTypeNode", "/api-v17/language#namedtypenode"], "[]"]} /></td> <td>Object types that belong to this union type.</td> </tr> </tbody> </table> <hr className="api-item-divider" />

EnumTypeDefinitionNode

Interface. An enum type definition in a type-system document.

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Members</div> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>kind</td> <td><ApiType parts={[["literal", "'EnumTypeDefinition'"]]} /></td> <td>The discriminator identifying the concrete AST or introspection kind.</td> </tr> <tr> <td>loc?</td> <td><ApiType parts={[["link", "Location", "/api-v17/language#location"]]} /></td> <td>The source location for this AST node, if location tracking was enabled.</td> </tr> <tr> <td>description?</td> <td><ApiType parts={[["link", "StringValueNode", "/api-v17/language#stringvaluenode"]]} /></td> <td>The optional GraphQL description associated with this definition.</td> </tr> <tr> <td>name</td> <td><ApiType parts={[["link", "NameNode", "/api-v17/language#namenode"]]} /></td> <td>Name node identifying this AST node.</td> </tr> <tr> <td>directives?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "ConstDirectiveNode", "/api-v17/language#constdirectivenode"], "[]"]} /></td> <td>Directives available in this schema or applied to this AST node.</td> </tr> <tr> <td>values?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "EnumValueDefinitionNode", "/api-v17/language#enumvaluedefinitionnode"], "[]"]} /></td> <td>Values contained in this enum, list, or input-object definition.</td> </tr> </tbody> </table> <hr className="api-item-divider" />

EnumValueDefinitionNode

Interface. An enum value definition.

InputObjectTypeDefinitionNode

Interface. An input object type definition in a type-system document.

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Members</div> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>kind</td> <td><ApiType parts={[["literal", "'InputObjectTypeDefinition'"]]} /></td> <td>The discriminator identifying the concrete AST or introspection kind.</td> </tr> <tr> <td>loc?</td> <td><ApiType parts={[["link", "Location", "/api-v17/language#location"]]} /></td> <td>The source location for this AST node, if location tracking was enabled.</td> </tr> <tr> <td>description?</td> <td><ApiType parts={[["link", "StringValueNode", "/api-v17/language#stringvaluenode"]]} /></td> <td>The optional GraphQL description associated with this definition.</td> </tr> <tr> <td>name</td> <td><ApiType parts={[["link", "NameNode", "/api-v17/language#namenode"]]} /></td> <td>Name node identifying this AST node.</td> </tr> <tr> <td>directives?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "ConstDirectiveNode", "/api-v17/language#constdirectivenode"], "[]"]} /></td> <td>Directives available in this schema or applied to this AST node.</td> </tr> <tr> <td>fields?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "InputValueDefinitionNode", "/api-v17/language#inputvaluedefinitionnode"], "[]"]} /></td> <td>Fields declared by this object, interface, input object, or literal.</td> </tr> </tbody> </table> <hr className="api-item-divider" />

DirectiveDefinitionNode

Interface. A directive definition in a type-system document.

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Members</div> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>kind</td> <td><ApiType parts={[["literal", "'DirectiveDefinition'"]]} /></td> <td>The discriminator identifying the concrete AST or introspection kind.</td> </tr> <tr> <td>loc?</td> <td><ApiType parts={[["link", "Location", "/api-v17/language#location"]]} /></td> <td>The source location for this AST node, if location tracking was enabled.</td> </tr> <tr> <td>description?</td> <td><ApiType parts={[["link", "StringValueNode", "/api-v17/language#stringvaluenode"]]} /></td> <td>The optional GraphQL description associated with this definition.</td> </tr> <tr> <td>name</td> <td><ApiType parts={[["link", "NameNode", "/api-v17/language#namenode"]]} /></td> <td>Name node identifying this AST node.</td> </tr> <tr> <td>arguments?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "InputValueDefinitionNode", "/api-v17/language#inputvaluedefinitionnode"], "[]"]} /></td> <td>Arguments supplied to this field, directive, or coordinate.</td> </tr> <tr> <td>directives?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "ConstDirectiveNode", "/api-v17/language#constdirectivenode"], "[]"]} /></td> <td>Directives available in this schema or applied to this AST node.</td> </tr> <tr> <td>repeatable</td> <td><ApiType parts={[["keyword", "boolean"]]} /></td> <td>Whether this directive may appear more than once at the same location.</td> </tr> <tr> <td>locations</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "NameNode", "/api-v17/language#namenode"], "[]"]} /></td> <td>Locations where this directive may be applied.</td> </tr> </tbody> </table> <hr className="api-item-divider" />

TypeSystemExtensionNode

Type alias. Any type-system extension that may appear in a schema extension document.

SchemaExtensionNode

Interface. A schema extension in a type-system document.

TypeExtensionNode

Type alias. Any named type extension that may appear in a schema extension document.

ScalarTypeExtensionNode

Interface. A scalar type extension.

ObjectTypeExtensionNode

Interface. An object type extension.

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Members</div> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>kind</td> <td><ApiType parts={[["literal", "'ObjectTypeExtension'"]]} /></td> <td>The discriminator identifying the concrete AST or introspection kind.</td> </tr> <tr> <td>loc?</td> <td><ApiType parts={[["link", "Location", "/api-v17/language#location"]]} /></td> <td>The source location for this AST node, if location tracking was enabled.</td> </tr> <tr> <td>name</td> <td><ApiType parts={[["link", "NameNode", "/api-v17/language#namenode"]]} /></td> <td>Name node identifying this AST node.</td> </tr> <tr> <td>interfaces?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "NamedTypeNode", "/api-v17/language#namedtypenode"], "[]"]} /></td> <td>Interfaces implemented by this object or interface type.</td> </tr> <tr> <td>directives?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "ConstDirectiveNode", "/api-v17/language#constdirectivenode"], "[]"]} /></td> <td>Directives available in this schema or applied to this AST node.</td> </tr> <tr> <td>fields?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "FieldDefinitionNode", "/api-v17/language#fielddefinitionnode"], "[]"]} /></td> <td>Fields declared by this object, interface, input object, or literal.</td> </tr> </tbody> </table> <hr className="api-item-divider" />

InterfaceTypeExtensionNode

Interface. An interface type extension.

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Members</div> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>kind</td> <td><ApiType parts={[["literal", "'InterfaceTypeExtension'"]]} /></td> <td>The discriminator identifying the concrete AST or introspection kind.</td> </tr> <tr> <td>loc?</td> <td><ApiType parts={[["link", "Location", "/api-v17/language#location"]]} /></td> <td>The source location for this AST node, if location tracking was enabled.</td> </tr> <tr> <td>name</td> <td><ApiType parts={[["link", "NameNode", "/api-v17/language#namenode"]]} /></td> <td>Name node identifying this AST node.</td> </tr> <tr> <td>interfaces?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "NamedTypeNode", "/api-v17/language#namedtypenode"], "[]"]} /></td> <td>Interfaces implemented by this object or interface type.</td> </tr> <tr> <td>directives?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "ConstDirectiveNode", "/api-v17/language#constdirectivenode"], "[]"]} /></td> <td>Directives available in this schema or applied to this AST node.</td> </tr> <tr> <td>fields?</td> <td><ApiType parts={[["keyword", "readonly"], " ", ["link", "FieldDefinitionNode", "/api-v17/language#fielddefinitionnode"], "[]"]} /></td> <td>Fields declared by this object, interface, input object, or literal.</td> </tr> </tbody> </table> <hr className="api-item-divider" />

UnionTypeExtensionNode

Interface. A union type extension.

EnumTypeExtensionNode

Interface. An enum type extension.

InputObjectTypeExtensionNode

Interface. An input object type extension.

DirectiveExtensionNode

Interface. A directive extension.

SchemaCoordinateNode

Type alias. Any AST node representing a GraphQL schema coordinate.

TypeCoordinateNode

Interface. A schema coordinate that refers to a named type.

MemberCoordinateNode

Interface. A schema coordinate that refers to a member of a named type.

ArgumentCoordinateNode

Interface. A schema coordinate that refers to a field or directive argument.

DirectiveCoordinateNode

Interface. A schema coordinate that refers to a directive.

DirectiveArgumentCoordinateNode

Interface. A schema coordinate that refers to a directive argument.

Category: Kinds

<div className="api-category-toc"> <p> <strong>Enumerations:</strong>

<a href="/api-v17/language#operationtypenode">OperationTypeNode</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#directivelocation">DirectiveLocation</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#kind">Kind</a>

</p> </div>

Enumerations

OperationTypeNode

Enumeration. The operation types supported by GraphQL executable definitions.

This is not a TypeScript enum. GraphQL.js exports OperationTypeNode as both a runtime const object of literal values and a TypeScript type alias for those values.

DirectiveLocation

Enumeration. The set of allowed directive location values.

This is not a TypeScript enum. GraphQL.js exports DirectiveLocation as both a runtime const object of literal values and a TypeScript type alias for those values.

Kind

Enumeration.

This is not a TypeScript enum. GraphQL.js exports Kind as both a runtime namespace object of literal values and a TypeScript type alias for those values.

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Members</div> <table> <thead> <tr> <th>Name</th> <th>Value</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>{"NAME"}</code></td> <td><code>{"\"Name\""}</code></td> <td>AST kind for name nodes.</td> </tr> <tr> <td><code>{"DOCUMENT"}</code></td> <td><code>{"\"Document\""}</code></td> <td>AST kind for document nodes.</td> </tr> <tr> <td><code>{"OPERATION_DEFINITION"}</code></td> <td><code>{"\"OperationDefinition\""}</code></td> <td>AST kind for operation definition nodes.</td> </tr> <tr> <td><code>{"VARIABLE_DEFINITION"}</code></td> <td><code>{"\"VariableDefinition\""}</code></td> <td>AST kind for variable definition nodes.</td> </tr> <tr> <td><code>{"SELECTION_SET"}</code></td> <td><code>{"\"SelectionSet\""}</code></td> <td>AST kind for selection set nodes.</td> </tr> <tr> <td><code>{"FIELD"}</code></td> <td><code>{"\"Field\""}</code></td> <td>AST kind for field selection nodes.</td> </tr> <tr> <td><code>{"ARGUMENT"}</code></td> <td><code>{"\"Argument\""}</code></td> <td>AST kind for argument nodes.</td> </tr> <tr> <td><code>{"FRAGMENT_ARGUMENT"}</code></td> <td><code>{"\"FragmentArgument\""}</code></td> <td>AST kind for fragment argument nodes.</td> </tr> <tr> <td><code>{"FRAGMENT_SPREAD"}</code></td> <td><code>{"\"FragmentSpread\""}</code></td> <td>AST kind for fragment spread nodes.</td> </tr> <tr> <td><code>{"INLINE_FRAGMENT"}</code></td> <td><code>{"\"InlineFragment\""}</code></td> <td>AST kind for inline fragment nodes.</td> </tr> <tr> <td><code>{"FRAGMENT_DEFINITION"}</code></td> <td><code>{"\"FragmentDefinition\""}</code></td> <td>AST kind for fragment definition nodes.</td> </tr> <tr> <td><code>{"VARIABLE"}</code></td> <td><code>{"\"Variable\""}</code></td> <td>AST kind for variable reference nodes.</td> </tr> <tr> <td><code>{"INT"}</code></td> <td><code>{"\"IntValue\""}</code></td> <td>AST kind for integer value nodes.</td> </tr> <tr> <td><code>{"FLOAT"}</code></td> <td><code>{"\"FloatValue\""}</code></td> <td>AST kind for floating-point value nodes.</td> </tr> <tr> <td><code>{"STRING"}</code></td> <td><code>{"\"StringValue\""}</code></td> <td>AST kind for string value nodes.</td> </tr> <tr> <td><code>{"BOOLEAN"}</code></td> <td><code>{"\"BooleanValue\""}</code></td> <td>AST kind for boolean value nodes.</td> </tr> <tr> <td><code>{"NULL"}</code></td> <td><code>{"\"NullValue\""}</code></td> <td>AST kind for null value nodes.</td> </tr> <tr> <td><code>{"ENUM"}</code></td> <td><code>{"\"EnumValue\""}</code></td> <td>AST kind for enum value nodes.</td> </tr> <tr> <td><code>{"LIST"}</code></td> <td><code>{"\"ListValue\""}</code></td> <td>AST kind for list value nodes.</td> </tr> <tr> <td><code>{"OBJECT"}</code></td> <td><code>{"\"ObjectValue\""}</code></td> <td>AST kind for object value nodes.</td> </tr> <tr> <td><code>{"OBJECT_FIELD"}</code></td> <td><code>{"\"ObjectField\""}</code></td> <td>AST kind for object field nodes.</td> </tr> <tr> <td><code>{"DIRECTIVE"}</code></td> <td><code>{"\"Directive\""}</code></td> <td>AST kind for directive nodes.</td> </tr> <tr> <td><code>{"NAMED_TYPE"}</code></td> <td><code>{"\"NamedType\""}</code></td> <td>AST kind for named type reference nodes.</td> </tr> <tr> <td><code>{"LIST_TYPE"}</code></td> <td><code>{"\"ListType\""}</code></td> <td>AST kind for list type reference nodes.</td> </tr> <tr> <td><code>{"NON_NULL_TYPE"}</code></td> <td><code>{"\"NonNullType\""}</code></td> <td>AST kind for non-null type reference nodes.</td> </tr> <tr> <td><code>{"SCHEMA_DEFINITION"}</code></td> <td><code>{"\"SchemaDefinition\""}</code></td> <td>AST kind for schema definition nodes.</td> </tr> <tr> <td><code>{"OPERATION_TYPE_DEFINITION"}</code></td> <td><code>{"\"OperationTypeDefinition\""}</code></td> <td>AST kind for operation type definition nodes.</td> </tr> <tr> <td><code>{"SCALAR_TYPE_DEFINITION"}</code></td> <td><code>{"\"ScalarTypeDefinition\""}</code></td> <td>AST kind for scalar type definition nodes.</td> </tr> <tr> <td><code>{"OBJECT_TYPE_DEFINITION"}</code></td> <td><code>{"\"ObjectTypeDefinition\""}</code></td> <td>AST kind for object type definition nodes.</td> </tr> <tr> <td><code>{"FIELD_DEFINITION"}</code></td> <td><code>{"\"FieldDefinition\""}</code></td> <td>AST kind for field definition nodes.</td> </tr> <tr> <td><code>{"INPUT_VALUE_DEFINITION"}</code></td> <td><code>{"\"InputValueDefinition\""}</code></td> <td>AST kind for input value definition nodes.</td> </tr> <tr> <td><code>{"INTERFACE_TYPE_DEFINITION"}</code></td> <td><code>{"\"InterfaceTypeDefinition\""}</code></td> <td>AST kind for interface type definition nodes.</td> </tr> <tr> <td><code>{"UNION_TYPE_DEFINITION"}</code></td> <td><code>{"\"UnionTypeDefinition\""}</code></td> <td>AST kind for union type definition nodes.</td> </tr> <tr> <td><code>{"ENUM_TYPE_DEFINITION"}</code></td> <td><code>{"\"EnumTypeDefinition\""}</code></td> <td>AST kind for enum type definition nodes.</td> </tr> <tr> <td><code>{"ENUM_VALUE_DEFINITION"}</code></td> <td><code>{"\"EnumValueDefinition\""}</code></td> <td>AST kind for enum value definition nodes.</td> </tr> <tr> <td><code>{"INPUT_OBJECT_TYPE_DEFINITION"}</code></td> <td><code>{"\"InputObjectTypeDefinition\""}</code></td> <td>AST kind for input object type definition nodes.</td> </tr> <tr> <td><code>{"DIRECTIVE_DEFINITION"}</code></td> <td><code>{"\"DirectiveDefinition\""}</code></td> <td>AST kind for directive definition nodes.</td> </tr> <tr> <td><code>{"SCHEMA_EXTENSION"}</code></td> <td><code>{"\"SchemaExtension\""}</code></td> <td>AST kind for schema extension nodes.</td> </tr> <tr> <td><code>{"DIRECTIVE_EXTENSION"}</code></td> <td><code>{"\"DirectiveExtension\""}</code></td> <td>AST kind for directive extension nodes.</td> </tr> <tr> <td><code>{"SCALAR_TYPE_EXTENSION"}</code></td> <td><code>{"\"ScalarTypeExtension\""}</code></td> <td>AST kind for scalar type extension nodes.</td> </tr> <tr> <td><code>{"OBJECT_TYPE_EXTENSION"}</code></td> <td><code>{"\"ObjectTypeExtension\""}</code></td> <td>AST kind for object type extension nodes.</td> </tr> <tr> <td><code>{"INTERFACE_TYPE_EXTENSION"}</code></td> <td><code>{"\"InterfaceTypeExtension\""}</code></td> <td>AST kind for interface type extension nodes.</td> </tr> <tr> <td><code>{"UNION_TYPE_EXTENSION"}</code></td> <td><code>{"\"UnionTypeExtension\""}</code></td> <td>AST kind for union type extension nodes.</td> </tr> <tr> <td><code>{"ENUM_TYPE_EXTENSION"}</code></td> <td><code>{"\"EnumTypeExtension\""}</code></td> <td>AST kind for enum type extension nodes.</td> </tr> <tr> <td><code>{"INPUT_OBJECT_TYPE_EXTENSION"}</code></td> <td><code>{"\"InputObjectTypeExtension\""}</code></td> <td>AST kind for input object type extension nodes.</td> </tr> <tr> <td><code>{"TYPE_COORDINATE"}</code></td> <td><code>{"\"TypeCoordinate\""}</code></td> <td>AST kind for type coordinate nodes.</td> </tr> <tr> <td><code>{"MEMBER_COORDINATE"}</code></td> <td><code>{"\"MemberCoordinate\""}</code></td> <td>AST kind for member coordinate nodes.</td> </tr> <tr> <td><code>{"ARGUMENT_COORDINATE"}</code></td> <td><code>{"\"ArgumentCoordinate\""}</code></td> <td>AST kind for argument coordinate nodes.</td> </tr> <tr> <td><code>{"DIRECTIVE_COORDINATE"}</code></td> <td><code>{"\"DirectiveCoordinate\""}</code></td> <td>AST kind for directive coordinate nodes.</td> </tr> <tr> <td><code>{"DIRECTIVE_ARGUMENT_COORDINATE"}</code></td> <td><code>{"\"DirectiveArgumentCoordinate\""}</code></td> <td>AST kind for directive argument coordinate nodes.</td> </tr> </tbody> </table>

Category: Lexing

<div className="api-category-toc"> <p> <strong>Classes:</strong>

<a href="/api-v17/language#lexer">Lexer</a>

</p> <p> <strong>Enumerations:</strong>

<a href="/api-v17/language#tokenkind">TokenKind</a>

</p> </div>

Classes

Lexer

Given a Source object, creates a Lexer for that source. A Lexer is a stateful stream generator in that every time it is advanced, it returns the next token in the Source. Assuming the source lexes, the final Token emitted by the lexer will be of kind EOF, after which the lexer will repeatedly return the same EOF token whenever called.

Constructor

Creates a Lexer instance.

Signature:

Members

<table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>source</td> <td><ApiType parts={[["link", "Source", "/api-v17/language#source"]]} /></td> <td>Source document used to derive error locations.</td> </tr> <tr> <td>lastToken</td> <td><ApiType parts={[["link", "Token", "/api-v17/language#token"]]} /></td> <td>Most recent non-ignored token returned by the lexer.</td> </tr> <tr> <td>token</td> <td><ApiType parts={[["link", "Token", "/api-v17/language#token"]]} /></td> <td>Current non-ignored token at the lexer cursor.</td> </tr> <tr> <td>line</td> <td><ApiType parts={[["keyword", "number"]]} /></td> <td>The (1-indexed) line containing the current token.</td> </tr> <tr> <td>lineStart</td> <td><ApiType parts={[["keyword", "number"]]} /></td> <td>Character offset where the current line starts.</td> </tr> </tbody> </table> <hr className="api-subsection-divider" />

advance()

Advances the token stream to the next non-ignored token.

Signature:

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Returns</div> <table> <thead> <tr> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><ApiType parts={[["link", "Token", "/api-v17/language#token"]]} /></td> <td>The next non-ignored token.</td> </tr> </tbody> </table> <hr className="api-subsection-divider" /> <div className="api-subsection-title">Example</div>

import { Lexer, Source } from 'graphql/language';

const lexer = new Lexer(new Source('{ hello }'));
const token = lexer.advance();

token.kind; // => '{'
lexer.token; // => token

lookahead()

Looks ahead and returns the next non-ignored token, but does not change the state of Lexer.

Signature:

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Returns</div> <table> <thead> <tr> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><ApiType parts={[["link", "Token", "/api-v17/language#token"]]} /></td> <td>The next non-ignored token without advancing the lexer.</td> </tr> </tbody> </table> <hr className="api-subsection-divider" /> <div className="api-subsection-title">Example</div>

import { Lexer, Source } from 'graphql/language';

const lexer = new Lexer(new Source('{ hello }'));
const token = lexer.lookahead();

token.kind; // => '{'
lexer.token.kind; // => '<SOF>'

Enumerations

TokenKind

Enumeration. An exported enum describing the different kinds of tokens that the lexer emits.

This is not a TypeScript enum. GraphQL.js exports TokenKind as both a runtime const object of literal values and a TypeScript type alias for those values.

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Members</div> <table> <thead> <tr> <th>Name</th> <th>Value</th> </tr> </thead> <tbody> <tr> <td><code>{"SOF"}</code></td> <td><code>{"\"<SOF>\""}</code></td> </tr> <tr> <td><code>{"EOF"}</code></td> <td><code>{"\"<EOF>\""}</code></td> </tr> <tr> <td><code>{"BANG"}</code></td> <td><code>{"\"!\""}</code></td> </tr> <tr> <td><code>{"DOLLAR"}</code></td> <td><code>{"\"$\""}</code></td> </tr> <tr> <td><code>{"AMP"}</code></td> <td><code>{"\"&\""}</code></td> </tr> <tr> <td><code>{"PAREN_L"}</code></td> <td><code>{"\"(\""}</code></td> </tr> <tr> <td><code>{"PAREN_R"}</code></td> <td><code>{"\")\""}</code></td> </tr> <tr> <td><code>{"DOT"}</code></td> <td><code>{"\".\""}</code></td> </tr> <tr> <td><code>{"SPREAD"}</code></td> <td><code>{"\"...\""}</code></td> </tr> <tr> <td><code>{"COLON"}</code></td> <td><code>{"\":\""}</code></td> </tr> <tr> <td><code>{"EQUALS"}</code></td> <td><code>{"\"=\""}</code></td> </tr> <tr> <td><code>{"AT"}</code></td> <td><code>{"\"@\""}</code></td> </tr> <tr> <td><code>{"BRACKET_L"}</code></td> <td><code>{"\"[\""}</code></td> </tr> <tr> <td><code>{"BRACKET_R"}</code></td> <td><code>{"\"]\""}</code></td> </tr> <tr> <td><code>{"BRACE_L"}</code></td> <td><code>{"\"{\""}</code></td> </tr> <tr> <td><code>{"PIPE"}</code></td> <td><code>{"\"\u007c\""}</code></td> </tr> <tr> <td><code>{"BRACE_R"}</code></td> <td><code>{"\"}\""}</code></td> </tr> <tr> <td><code>{"NAME"}</code></td> <td><code>{"\"Name\""}</code></td> </tr> <tr> <td><code>{"INT"}</code></td> <td><code>{"\"Int\""}</code></td> </tr> <tr> <td><code>{"FLOAT"}</code></td> <td><code>{"\"Float\""}</code></td> </tr> <tr> <td><code>{"STRING"}</code></td> <td><code>{"\"String\""}</code></td> </tr> <tr> <td><code>{"BLOCK_STRING"}</code></td> <td><code>{"\"BlockString\""}</code></td> </tr> <tr> <td><code>{"COMMENT"}</code></td> <td><code>{"\"Comment\""}</code></td> </tr> </tbody> </table>

Category: Source

<div className="api-category-toc"> <p> <strong>Classes:</strong>

<a href="/api-v17/language#source">Source</a>

</p> <p> <strong>Functions:</strong>

<a href="/api-v17/language#getlocation">getLocation()</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#printlocation">printLocation()</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#printsourcelocation">printSourceLocation()</a>

</p> <p> <strong>Types:</strong>

<a href="/api-v17/language#sourcelocation">SourceLocation</a>

</p> </div>

Classes

Source

A representation of source input to GraphQL. The name and locationOffset parameters are optional, but they are useful for clients who store GraphQL documents in source files. For example, if the GraphQL input starts at line 40 in a file named Foo.graphql, it might be useful for name to be "Foo.graphql" and location to be { line: 40, column: 1 }. The line and column properties in locationOffset are 1-indexed.

Constructor

Creates a Source instance.

Signature:

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Arguments</div> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Default</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>body</td> <td><ApiType parts={[["keyword", "string"]]} /></td> <td></td> <td>The GraphQL source text.</td> </tr> <tr> <td>name</td> <td><ApiType parts={[["keyword", "string"]]} /></td> <td><ApiType parts={[["literal", "'GraphQL request'"]]} /></td> <td>Name used in diagnostics for this source.</td> </tr> <tr> <td>locationOffset</td> <td><ApiType parts={["\u007b ", ["property", "line"], ": ", ["keyword", "number"], "; ", ["property", "column"], ": ", ["keyword", "number"], " \u007d"]} /></td> <td><ApiType parts={["\u007b line: ", ["literal", "1"], ", column: ", ["literal", "1"], " \u007d"]} /></td> <td>One-indexed line and column where this source begins.</td> </tr> </tbody> </table> <hr className="api-subsection-divider" />

Members

<table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>body</td> <td><ApiType parts={[["keyword", "string"]]} /></td> <td>The GraphQL source text.</td> </tr> <tr> <td>name</td> <td><ApiType parts={[["keyword", "string"]]} /></td> <td>Name used in diagnostics for this source, such as a file path or request name.</td> </tr> <tr> <td>locationOffset</td> <td><ApiType parts={["\u007b ", ["property", "line"], ": ", ["keyword", "number"], "; ", ["property", "column"], ": ", ["keyword", "number"], " \u007d"]} /></td> <td>One-indexed line and column where this source begins.</td> </tr> </tbody> </table>

Functions

getLocation()

Takes a Source and a UTF-8 character offset, and returns the corresponding line and column as a SourceLocation.

Signature:

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Arguments</div> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>source</td> <td><ApiType parts={[["link", "Source", "/api-v17/language#source"]]} /></td> <td>The source document that contains the position.</td> </tr> <tr> <td>position</td> <td><ApiType parts={[["keyword", "number"]]} /></td> <td>The UTF-8 character offset in the source body.</td> </tr> </tbody> </table> <hr className="api-subsection-divider" /> <div className="api-subsection-title">Returns</div> <table> <thead> <tr> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><ApiType parts={[["link", "SourceLocation", "/api-v17/language#sourcelocation"]]} /></td> <td>The 1-indexed line and column for the given source position.</td> </tr> </tbody> </table> <hr className="api-subsection-divider" /> <div className="api-subsection-title">Example</div>

import { Source, getLocation } from 'graphql/language';

const source = new Source('type Query { hello: String }');
const location = getLocation(source, 13);

location; // => { line: 1, column: 14 }

printLocation()

Render a helpful description of the location in the GraphQL Source document.

Signature:

import { parse, printLocation } from 'graphql/language';

const document = parse('type Query { hello: String }');
const location = document.definitions[0].loc;

if (location) {
  const printed = printLocation(location);

  printed; // => 'GraphQL request:1:1\n1 | type Query { hello: String }\n  | ^'
}

printSourceLocation()

Render a helpful description of the location in the GraphQL Source document.

Signature:

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Arguments</div> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>source</td> <td><ApiType parts={[["link", "Source", "/api-v17/language#source"]]} /></td> <td>The source document that contains the location.</td> </tr> <tr> <td>sourceLocation</td> <td><ApiType parts={[["link", "SourceLocation", "/api-v17/language#sourcelocation"]]} /></td> <td>The 1-indexed line and column to print.</td> </tr> </tbody> </table> <hr className="api-subsection-divider" /> <div className="api-subsection-title">Returns</div> <table> <thead> <tr> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><ApiType parts={[["keyword", "string"]]} /></td> <td>A formatted source excerpt with line and column information.</td> </tr> </tbody> </table> <hr className="api-subsection-divider" /> <div className="api-subsection-title">Example</div>

import { Source, printSourceLocation } from 'graphql/language';

const source = new Source('type Query { hello: String }');
const printed = printSourceLocation(source, { line: 1, column: 14 });

printed; // => 'GraphQL request:1:14\n1 | type Query { hello: String }\n  |              ^'

Types

SourceLocation

Interface. Represents a location in a Source.

Category: Parsing

<div className="api-category-toc"> <p> <strong>Functions:</strong>

<a href="/api-v17/language#parse">parse()</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#parsevalue">parseValue()</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#parseconstvalue">parseConstValue()</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#parsetype">parseType()</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#parseschemacoordinate">parseSchemaCoordinate()</a>

</p> <p> <strong>Types:</strong>

<a href="/api-v17/language#parseoptions">ParseOptions</a>

</p> </div>

Functions

parse()

Given a GraphQL source, parses it into a Document. Throws GraphQLError if a syntax error is encountered.

Signature:

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Arguments</div> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>source</td> <td><ApiType parts={[["keyword", "string"], " \u007c ", ["link", "Source", "/api-v17/language#source"]]} /></td> <td>A GraphQL source string or source object.</td> </tr> <tr> <td>options?</td> <td><ApiType parts={[["link", "ParseOptions", "/api-v17/language#parseoptions"]]} /></td> <td>Optional parser configuration.</td> </tr> </tbody> </table> <hr className="api-subsection-divider" /> <div className="api-subsection-title">Returns</div> <table> <thead> <tr> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><ApiType parts={[["link", "DocumentNode", "/api-v17/language#documentnode"]]} /></td> <td>The parsed GraphQL document AST.</td> </tr> </tbody> </table> <hr className="api-subsection-divider" /> <div className="api-subsection-title">Example 1</div>

// Parse a GraphQL document with the default parser options.
import { parse } from 'graphql/language';

const document = parse('{ hero { name } }');

document.kind; // => 'Document'

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Example 2</div>

// This variant enables parser options and provides an explicit lexer.
import { Lexer, Source, parse } from 'graphql/language';

const document = parse(`
  {
    t { ...A(var: true) }
  }
  fragment A($var: Boolean = false) on T {
    name
  }
`, {
  experimentalFragmentArguments: true,
  maxTokens: 80,
  noLocation: true,
});
const directiveDocument = parse('directive @foo @bar on FIELD', {
  experimentalDirectivesOnDirectiveDefinitions: true,
});
const source = new Source('{ hero }');
const lexerDocument = parse(source, { lexer: new Lexer(source) });

document.definitions[0].kind; // => 'OperationDefinition'
document.definitions[1].kind; // => 'FragmentDefinition'
document.loc; // => undefined
directiveDocument.definitions[0].kind; // => 'DirectiveDefinition'
lexerDocument.definitions[0].kind; // => 'OperationDefinition'

parseValue()

Given a string containing a GraphQL value (ex. [42]), parse the AST for that value. Throws GraphQLError if a syntax error is encountered.

This is useful within tools that operate upon GraphQL Values directly and in isolation of complete GraphQL documents.

Consider providing the results to the utility function: valueFromAST().

Signature:

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Arguments</div> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>source</td> <td><ApiType parts={[["keyword", "string"], " \u007c ", ["link", "Source", "/api-v17/language#source"]]} /></td> <td>A GraphQL source string or source object containing a value.</td> </tr> <tr> <td>options?</td> <td><ApiType parts={[["link", "ParseOptions", "/api-v17/language#parseoptions"]]} /></td> <td>Optional parser configuration.</td> </tr> </tbody> </table> <hr className="api-subsection-divider" /> <div className="api-subsection-title">Returns</div> <table> <thead> <tr> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><ApiType parts={[["link", "ValueNode", "/api-v17/language#valuenode"]]} /></td> <td>The parsed GraphQL value AST.</td> </tr> </tbody> </table> <hr className="api-subsection-divider" /> <div className="api-subsection-title">Example</div>

import { parseValue } from 'graphql/language';

const value = parseValue('[42]');

value.kind; // => 'ListValue'

parseConstValue()

Similar to parseValue(), but raises a parse error if it encounters a variable. The return type will be a constant value.

Signature:

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Arguments</div> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>source</td> <td><ApiType parts={[["keyword", "string"], " \u007c ", ["link", "Source", "/api-v17/language#source"]]} /></td> <td>A GraphQL source string or source object containing a constant value.</td> </tr> <tr> <td>options?</td> <td><ApiType parts={[["link", "ParseOptions", "/api-v17/language#parseoptions"]]} /></td> <td>Optional parser configuration.</td> </tr> </tbody> </table> <hr className="api-subsection-divider" /> <div className="api-subsection-title">Returns</div> <table> <thead> <tr> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><ApiType parts={[["link", "ConstValueNode", "/api-v17/language#constvaluenode"]]} /></td> <td>The parsed GraphQL constant value AST.</td> </tr> </tbody> </table> <hr className="api-subsection-divider" /> <div className="api-subsection-title">Example</div>

import { parseConstValue } from 'graphql/language';

const value = parseConstValue('{ enabled: true }');

value.kind; // => 'ObjectValue'
parseConstValue('$variable'); // throws an error

parseType()

Given a string containing a GraphQL Type (ex. [Int!]), parse the AST for that type. Throws GraphQLError if a syntax error is encountered.

This is useful within tools that operate upon GraphQL Types directly and in isolation of complete GraphQL documents.

Consider providing the results to the utility function: typeFromAST().

Signature:

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Arguments</div> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>source</td> <td><ApiType parts={[["keyword", "string"], " \u007c ", ["link", "Source", "/api-v17/language#source"]]} /></td> <td>A GraphQL source string or source object containing a type reference.</td> </tr> <tr> <td>options?</td> <td><ApiType parts={[["link", "ParseOptions", "/api-v17/language#parseoptions"]]} /></td> <td>Optional parser configuration.</td> </tr> </tbody> </table> <hr className="api-subsection-divider" /> <div className="api-subsection-title">Returns</div> <table> <thead> <tr> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><ApiType parts={[["link", "TypeNode", "/api-v17/language#typenode"]]} /></td> <td>The parsed GraphQL type AST.</td> </tr> </tbody> </table> <hr className="api-subsection-divider" /> <div className="api-subsection-title">Example</div>

import { parseType } from 'graphql/language';

const type = parseType('[String!]');

type.kind; // => 'ListType'

parseSchemaCoordinate()

Given a string containing a GraphQL Schema Coordinate (ex. Type.field), parse the AST for that schema coordinate. Throws GraphQLError if a syntax error is encountered.

Consider providing the results to the utility function: resolveASTSchemaCoordinate(). Or calling resolveSchemaCoordinate() directly with an unparsed source.

Signature:

import { parseSchemaCoordinate } from 'graphql/language';

const coordinate = parseSchemaCoordinate('Query.hero');

coordinate.kind; // => 'MemberCoordinate'

Types

ParseOptions

Interface. Configuration options to control parser behavior

in the source that they correspond to. This configuration flag

disables that behavior for performance or testing.</td> </tr> <tr> <td>maxTokens?</td> <td><ApiType parts={[["keyword", "number"]]} /></td> <td>Parser CPU and memory usage is linear to the number of tokens in a document

however in extreme cases it becomes quadratic due to memory exhaustion.

Parsing happens before validation so even invalid queries can burn lots of

CPU time and memory.

To prevent this you can set a maximum number of tokens allowed within a document.</td> </tr> <tr> <td>experimentalFragmentArguments?</td> <td><ApiType parts={[["keyword", "boolean"]]} /></td> <td>EXPERIMENTAL:

If enabled, the parser will understand and parse fragment variable definitions

and arguments on fragment spreads. Fragment variable definitions will be represented

in the <code>{"variableDefinitions"}</code> field of the FragmentDefinitionNode.

Fragment spread arguments will be represented in the <code>{"arguments"}</code> field of FragmentSpreadNode.</td> </tr> <tr> <td>experimentalDirectivesOnDirectiveDefinitions?</td> <td><ApiType parts={[["keyword", "boolean"]]} /></td> <td>EXPERIMENTAL:

If enabled, the parser will parse directives on directive definitions.

This syntax is not part of the GraphQL specification and may change.</td> </tr>

</tbody> </table> <hr className="api-subsection-divider" /> <div className="api-subsection-title">experimentalFragmentArguments Example</div>

graphql

{
  t { ...A(var: true) }
}
fragment A($var: Boolean = false) on T {
  ...B(x: $var)
}

<hr className="api-subsection-divider" /> <div className="api-subsection-title">experimentalDirectivesOnDirectiveDefinitions Example</div>

graphql

directive @foo @bar on FIELD

Category: AST Predicates

<div className="api-category-toc"> <p> <strong>Functions:</strong>

<a href="/api-v17/language#isdefinitionnode">isDefinitionNode()</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#isexecutabledefinitionnode">isExecutableDefinitionNode()</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#issubscriptionoperationdefinitionnode">isSubscriptionOperationDefinitionNode()</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#isselectionnode">isSelectionNode()</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#isvaluenode">isValueNode()</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#isconstvaluenode">isConstValueNode()</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#istypenode">isTypeNode()</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#istypesystemdefinitionnode">isTypeSystemDefinitionNode()</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#istypedefinitionnode">isTypeDefinitionNode()</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#istypesystemextensionnode">isTypeSystemExtensionNode()</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#istypeextensionnode">isTypeExtensionNode()</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#isschemacoordinatenode">isSchemaCoordinateNode()</a>

</p> </div>

Functions

isDefinitionNode()

Returns true when the AST node is a definition node.

Signature:

import { parse, isDefinitionNode } from 'graphql/language';

const document = parse('{ hello }');

isDefinitionNode(document.definitions[0]); // => true
isDefinitionNode(document); // => false

isExecutableDefinitionNode()

Returns true when the AST node is an executable definition node.

Signature:

import { parse, isExecutableDefinitionNode } from 'graphql/language';

const query = parse('{ hello }');
const schema = parse('type Query { hello: String }');

isExecutableDefinitionNode(query.definitions[0]); // => true
isExecutableDefinitionNode(schema.definitions[0]); // => false

isSubscriptionOperationDefinitionNode()

A type predicate for SubscriptionOperationDefinitionNode. Useful anywhere that must distinguish subscription operations from queries and mutations, such as the subscription execution pipeline which routes events through a different code path.

Signature:

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Arguments</div> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>node</td> <td><ApiType parts={[["link", "OperationDefinitionNode", "/api-v17/language#operationdefinitionnode"]]} /></td> <td>Operation definition node to test.</td> </tr> </tbody> </table> <hr className="api-subsection-divider" /> <div className="api-subsection-title">Returns</div> <table> <thead> <tr> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><ApiType parts={[["parameter", "node"], " ", ["keyword", "is"], " ", ["link", "SubscriptionOperationDefinitionNode", "/api-v17/language#subscriptionoperationdefinitionnode"]]} /></td> <td>True when the operation definition is a subscription.</td> </tr> </tbody> </table> <hr className="api-subsection-divider" /> <div className="api-subsection-title">Example</div>

import { parse, isSubscriptionOperationDefinitionNode } from 'graphql/language';

const subscription = parse('subscription { greeting }').definitions[0];
const query = parse('{ greeting }').definitions[0];

isSubscriptionOperationDefinitionNode(subscription); // => true
isSubscriptionOperationDefinitionNode(query); // => false

isSelectionNode()

Returns true when the AST node is a selection node.

Signature:

import { Kind, isSelectionNode } from 'graphql/language';

const field = { kind: Kind.FIELD, name: { kind: Kind.NAME, value: 'hello' } };
const document = { kind: Kind.DOCUMENT, definitions: [] };

isSelectionNode(field); // => true
isSelectionNode(document); // => false

isValueNode()

Returns true when the AST node is a value node.

Signature:

import { parseType, parseValue, isValueNode } from 'graphql/language';

const value = parseValue('[42]');
const type = parseType('[String!]');

isValueNode(value); // => true
isValueNode(type); // => false

isConstValueNode()

Returns true when the AST node is a constant value node.

Signature:

import { parseConstValue, parseValue, isConstValueNode } from 'graphql/language';

const value = parseConstValue('[42]');
const variable = parseValue('$id');

isConstValueNode(value); // => true
isConstValueNode(variable); // => false

isTypeNode()

Returns true when the AST node is a type node.

Signature:

import { parseType, parseValue, isTypeNode } from 'graphql/language';

const type = parseType('[String!]');
const value = parseValue('[42]');

isTypeNode(type); // => true
isTypeNode(value); // => false

isTypeSystemDefinitionNode()

Returns true when the AST node is a type system definition node.

Signature:

import { parse, isTypeSystemDefinitionNode } from 'graphql/language';

const schema = parse('type Query { hello: String }');
const query = parse('{ hello }');

isTypeSystemDefinitionNode(schema.definitions[0]); // => true
isTypeSystemDefinitionNode(query.definitions[0]); // => false

isTypeDefinitionNode()

Returns true when the AST node is a type definition node.

Signature:

import { parse, isTypeDefinitionNode } from 'graphql/language';

const typeDefinition = parse('type Query { hello: String }');
const directiveDefinition = parse('directive @cache on FIELD');

isTypeDefinitionNode(typeDefinition.definitions[0]); // => true
isTypeDefinitionNode(directiveDefinition.definitions[0]); // => false

isTypeSystemExtensionNode()

Returns true when the AST node is a type system extension node.

Signature:

import { parse, isTypeSystemExtensionNode } from 'graphql/language';

const extension = parse('extend type Query { hello: String }');
const definition = parse('type Query { hello: String }');

isTypeSystemExtensionNode(extension.definitions[0]); // => true
isTypeSystemExtensionNode(definition.definitions[0]); // => false

isTypeExtensionNode()

Returns true when the AST node is a type extension node.

Signature:

import { parse, isTypeExtensionNode } from 'graphql/language';

const extension = parse('extend type Query { hello: String }');
const schemaExtension = parse('extend schema { query: Query }');

isTypeExtensionNode(extension.definitions[0]); // => true
isTypeExtensionNode(schemaExtension.definitions[0]); // => false

isSchemaCoordinateNode()

Returns true when the AST node is a schema coordinate node.

Signature:

import {
  parse,
  parseSchemaCoordinate,
  isSchemaCoordinateNode,
} from 'graphql/language';

const coordinate = parseSchemaCoordinate('Query.hero');
const document = parse('{ hero }');

isSchemaCoordinateNode(coordinate); // => true
isSchemaCoordinateNode(document); // => false

Category: Printing

<div className="api-category-toc"> <p> <strong>Functions:</strong>

<a href="/api-v17/language#print">print()</a>

</p> </div>

Functions

print()

Converts an AST into a string, using one set of reasonable formatting rules.

Signature:

import { parse, print } from 'graphql';

const ast = parse('{ hero { name } }');
const text = print(ast);

text; // => '{\n  hero {\n    name\n  }\n}'

Category: Visiting

<div className="api-category-toc"> <p> <strong>Functions:</strong>

<a href="/api-v17/language#visitinparallel">visitInParallel()</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#getenterleaveforkind">getEnterLeaveForKind()</a>

</p> <p> <strong>Constants:</strong>

<a href="/api-v17/language#break">BREAK</a>

</p> <p> <strong>Types:</strong>

<a href="/api-v17/language#astvisitor">ASTVisitor</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#astvisitfn">ASTVisitFn</a>
<span aria-hidden="true">&middot;</span>
<a href="/api-v17/language#astvisitorkeymap">ASTVisitorKeyMap</a>

</p> </div>

Functions

visitInParallel()

Creates a new visitor instance which delegates to many visitors to run in parallel. Each visitor will be visited for each node before moving on.

If a prior visitor edits a node, no following visitors will see that node.

Signature:

import { parse, visit, visitInParallel } from 'graphql/language';

const document = parse('{ hero { name } }');
const events = [];

visit(
  document,
  visitInParallel([
    { Field: (node) => { events.push(`field:${node.name.value}`); } },
    { Name: (node) => { events.push(`name:${node.value}`); } },
  ]),
);

events; // => ['field:hero', 'name:hero', 'field:name', 'name:name']

getEnterLeaveForKind()

Given a visitor instance and a node kind, return EnterLeaveVisitor for that kind.

Signature:

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Arguments</div> <table> <thead> <tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>visitor</td> <td><ApiType parts={[["link", "ASTVisitor", "/api-v17/language#astvisitor"]]} /></td> <td>The visitor object to inspect.</td> </tr> <tr> <td>kind</td> <td><ApiType parts={[["link", "Kind", "/api-v17/language#kind"]]} /></td> <td>The AST node kind to resolve handlers for.</td> </tr> </tbody> </table> <hr className="api-subsection-divider" /> <div className="api-subsection-title">Returns</div> <table> <thead> <tr> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><ApiType parts={["\u007b\n ", ["property", "enter"], "?: ", ["link", "ASTVisitFn", "/api-v17/language#astvisitfn"], "\u003c", ["link", "ASTNode", "/api-v17/language#astnode"], "\u003e \u007c ", ["keyword", "undefined"], ";\n ", ["property", "leave"], "?: ", ["link", "ASTVisitFn", "/api-v17/language#astvisitfn"], "\u003c", ["link", "ASTNode", "/api-v17/language#astnode"], "\u003e \u007c ", ["keyword", "undefined"], ";\n\u007d"]} /></td> <td>The enter and leave handlers that apply for the given node kind.</td> </tr> </tbody> </table> <hr className="api-subsection-divider" /> <div className="api-subsection-title">Example</div>

import { Kind, getEnterLeaveForKind } from 'graphql/language';

const handlers = getEnterLeaveForKind({ Field: () => {} }, Kind.FIELD);

typeof handlers.enter; // => 'function'
handlers.leave; // => undefined

Constants

BREAK

A value that can be returned from a visitor function to stop traversal.

Types

ASTVisitor

Type alias. A visitor defines the callbacks called during AST traversal.

ASTVisitFn

Type alias. A visitor is composed of visit functions called for each node during traversal.

<hr className="api-subsection-divider" /> <div className="api-subsection-title">Type Parameters</div> <table> <thead> <tr> <th>Name</th> <th>Constraint</th> <th>Default</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>TVisitedNode</td> <td><ApiType parts={[["link", "ASTNode", "/api-v17/language#astnode"]]} /></td> <td></td> <td>AST node type handled by this visitor function.</td> </tr> </tbody> </table>

ASTVisitorKeyMap

Type alias. A visitor key map describes the traversable child properties for each node kind.