graphql-extra

Index

API Mixins Classes

API Public Classes

Internal Classes

Crud

Internal Interfaces

CrudConfig

API Mixins Type aliases

API Public Type aliases

AST Alias Type aliases

RootTypeDefinitionProps

AST Node Type aliases

Helper Type aliases

Internal Type aliases

Other Type aliases

InterfaceMixinNode

AST Alias Variables

API Mixins Functions

API Public Functions

AST Alias Functions

AST Guard Functions

AST Node Functions

Helper Functions

Internal Functions

API Public Object literals

AST Alias Object literals

type
value

AST Node Object literals

Helper Object literals

API Mixins Type aliases

ArgumentsMixinNode

ArgumentsMixinNode: DirectiveNode | FieldNode

DefaultValueMixinNode

DefaultValueMixinNode: InputValueDefinitionNode | VariableDefinitionNode

DescriptionMixinNode

DirectivesMixinNode

EnumValueDefinitionMixinNode

EnumValueDefinitionMixinNode: EnumTypeDefinitionNode | EnumTypeExtensionNode

FieldDefinitionsMixinNode

FieldDefinitionsMixinNode: InterfaceTypeDefinitionNode | InterfaceTypeExtensionNode | ObjectTypeDefinitionNode | ObjectTypeExtensionNode

InputValuesAsArgumentsMixinNode

InputValuesAsArgumentsMixinNode: FieldDefinitionNode | DirectiveDefinitionNode

InputValuesAsFieldsMixinNode

InputValuesAsFieldsMixinNode: InputObjectTypeDefinitionNode | InputObjectTypeExtensionNode

NameMixinNode

NameOptionalMixinNode

NameOptionalMixinNode: OperationDefinitionNode

NamedTypeMixinNode

NamedTypeMixinNode: OperationTypeDefinitionNode

OperationTypeDefinitionMixinNode

OperationTypeDefinitionMixinNode: SchemaDefinitionNode | GQL.SchemaExtensionNode

SelectionAssertionMixinNode

SelectionAssertionMixinNode: FieldNode | InlineFragmentNode | FragmentSpreadNode

SelectionSetMixinNode

SelectionSetMixinNode: FieldNode | FragmentDefinitionNode | InlineFragmentNode | OperationDefinitionNode | SelectionSetNode

TypeMixinNode

TypeMixinNode: FieldDefinitionNode | InputValueDefinitionNode | VariableDefinitionNode

UnionTypesMixinNode

UnionTypesMixinNode: UnionTypeDefinitionNode | UnionTypeExtensionNode

VariableMixinNode

VariableMixinNode: VariableDefinitionNode

API Public Type aliases

DefinitionApi

API for GraphQL DefinitionNode

SelectionApi

SelectionApi: FragmentSpreadApi | InlineFragmentApi | FieldApi

API for GraphQL SelectionNode

TypeDefinitonApi

API for GraphQL TypeDefinitionNode

TypeExtensionApi

API for GraphQL TypeExtensionNode

AST Alias Type aliases

RootTypeDefinitionProps

RootTypeDefinitionProps: Omit<AST.ObjectTypeDefinitionNodeProps, "name"> & { name?: NameNode | AST.NameNodeProps }

AST Node Type aliases

ArgumentNodeProps

ArgumentNodeProps: { name: NameNodeProps | NameNode; value: GQL.ValueNode }

ArgumentNode create input

Type declaration

name: NameNodeProps | NameNode
value: GQL.ValueNode

BooleanValueNodeObjProps

BooleanValueNodeObjProps: { value: boolean | string | number }

BooleanValueNode create input subtype

Type declaration

value: boolean | string | number

BooleanValueNodeProps

BooleanValueNodeProps: BooleanValueNodeObjProps | boolean | string | number

BooleanValueNode create input

DefinitionNodeProps

DefinitionNodeProps: TypeSystemDefinitionNodeProps | TypeSystemExtensionNodeProps | ExecutableDefinitionNodeProps

DefinitionNode create input

DirectiveDefinitionNodeProps

DirectiveDefinitionNodeProps: { arguments?: ReadonlyArray<InputValueDefinitionNodeProps | InputValueDefinitionNode>; description?: StringValueNodeProps | StringValueNode; locations: ReadonlyArray<GQL.DirectiveLocationEnum | NameNode>; name: NameNodeProps | NameNode; repeatable?: undefined | false | true }

DirectiveDefinitionNode create input

Type declaration

Optional arguments?: ReadonlyArray<InputValueDefinitionNodeProps | InputValueDefinitionNode>
Optional description?: StringValueNodeProps | StringValueNode
locations: ReadonlyArray<GQL.DirectiveLocationEnum | NameNode>
name: NameNodeProps | NameNode
Optional repeatable?: undefined | false | true

DirectiveNodeObjProps

DirectiveNodeObjProps: { arguments?: ReadonlyArray<ArgumentNode | ArgumentNodeProps>; name: NameNodeProps | NameNode }

DirectiveNode create input subtype

Type declaration

Optional arguments?: ReadonlyArray<ArgumentNode | ArgumentNodeProps>
name: NameNodeProps | NameNode

DirectiveNodeProps

DirectiveNodeProps: DirectiveNodeObjProps | string

DirectiveNode create input

DocumentNodeProps

DocumentNodeProps: { definitions: ReadonlyArray<DefinitionNodeProps | GQL.DefinitionNode> }

DocumentNode create input

Type declaration

definitions: ReadonlyArray<DefinitionNodeProps | GQL.DefinitionNode>

EnumTypeDefinitionNodeProps

EnumTypeDefinitionNodeProps: { description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; values?: ReadonlyArray<EnumValueDefinitionNodeProps | EnumValueDefinitionNode> }

EnumTypeDefinitionNode create input

Type declaration

Optional description?: StringValueNodeProps | StringValueNode
Optional directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>
name: NameNodeProps | NameNode
Optional values?: ReadonlyArray<EnumValueDefinitionNodeProps | EnumValueDefinitionNode>

EnumTypeExtensionNodeProps

EnumTypeExtensionNodeProps: { directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; values?: ReadonlyArray<EnumValueDefinitionNodeProps | EnumValueDefinitionNode> }

EnumTypeExtensionNode create input

Type declaration

Optional directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>
name: NameNodeProps | NameNode
Optional values?: ReadonlyArray<EnumValueDefinitionNodeProps | EnumValueDefinitionNode>

EnumValueDefinitionNodeObjProps

EnumValueDefinitionNodeObjProps: { description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode }

EnumValueDefinitionNode create input subtype

Type declaration

Optional description?: StringValueNodeProps | StringValueNode
Optional directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>
name: NameNodeProps | NameNode

EnumValueDefinitionNodeProps

EnumValueDefinitionNodeProps: EnumValueDefinitionNodeObjProps | string

EnumValueDefinitionNode create input

EnumValueNodeObjProps

EnumValueNodeObjProps: { value: string }

EnumValueNode create input subtype

Type declaration

value: string

EnumValueNodeProps

EnumValueNodeProps: EnumValueNodeObjProps | string

EnumValueNode create input

ExecutableDefinitionNodeProps

ExecutableDefinitionNodeProps: WithKind<OperationDefinitionNodeProps, "OperationDefinition"> | WithKind<FragmentDefinitionNodeProps, "FragmentDefinition">

ExecutableDefinitionNode create input

FieldDefinitionNodeProps

FieldDefinitionNodeProps: { arguments?: ReadonlyArray<InputValueDefinitionNodeProps | InputValueDefinitionNode>; description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; type: TypeNodeProps | GQL.TypeNode }

FieldDefinitionNode create input

Type declaration

Optional arguments?: ReadonlyArray<InputValueDefinitionNodeProps | InputValueDefinitionNode>
Optional description?: StringValueNodeProps | StringValueNode
Optional directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>
name: NameNodeProps | NameNode
type: TypeNodeProps | GQL.TypeNode

FieldNodeObjProps

FieldNodeObjProps: { alias?: NameNode | NameNodeProps; arguments?: ReadonlyArray<ArgumentNodeProps | ArgumentNode>; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNode | NameNodeProps; selections?: ReadonlyArray<SelectionNodeProps | GQL.SelectionNode> }

FieldNode create input subtype

Type declaration

Optional alias?: NameNode | NameNodeProps
Optional arguments?: ReadonlyArray<ArgumentNodeProps | ArgumentNode>
Optional directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>
name: NameNode | NameNodeProps
Optional selections?: ReadonlyArray<SelectionNodeProps | GQL.SelectionNode>

FieldNodeProps

FieldNodeProps: FieldNodeObjProps | string

FieldNode create input

FloatValueNodeObjProps

FloatValueNodeObjProps: { value: string | number }

IntValueNode create input subtype

Type declaration

value: string | number

FloatValueNodeProps

FloatValueNodeProps: FloatValueNodeObjProps | string | number

FloatValueNode create input

FragmentDefinitionNodeProps

FragmentDefinitionNodeProps: { directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; selections: ReadonlyArray<SelectionNodeProps | GQL.SelectionNode>; typeCondition: NamedTypeNodeProps | NamedTypeNode; variableDefinitions?: ReadonlyArray<VariableDefinitionNodeProps | VariableDefinitionNode> }

FragmentDefinitionNode create input

Type declaration

Optional directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>
name: NameNodeProps | NameNode
selections: ReadonlyArray<SelectionNodeProps | GQL.SelectionNode>
typeCondition: NamedTypeNodeProps | NamedTypeNode
Optional variableDefinitions?: ReadonlyArray<VariableDefinitionNodeProps | VariableDefinitionNode>

FragmentSpreadNodeObjProps

FragmentSpreadNodeObjProps: { directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode }

FragmentSpreadNode create input subtype

Type declaration

Optional directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>
name: NameNodeProps | NameNode

FragmentSpreadNodeProps

FragmentSpreadNodeProps: string | FragmentSpreadNodeObjProps

FragmentSpreadNode create input

InlineFragmentNodeProps

InlineFragmentNodeProps: { directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; selections: ReadonlyArray<SelectionNodeProps | GQL.SelectionNode>; typeCondition?: NamedTypeNodeProps | NamedTypeNode }

InlineFragmentNode create input

Type declaration

Optional directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>
selections: ReadonlyArray<SelectionNodeProps | GQL.SelectionNode>
Optional typeCondition?: NamedTypeNodeProps | NamedTypeNode

InputObjectTypeDefinitionNodeProps

InputObjectTypeDefinitionNodeProps: { description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<InputValueDefinitionNodeProps | InputValueDefinitionNode>; name: NameNodeProps | NameNode }

InputObjectTypeDefinitionNode create input

Type declaration

Optional description?: StringValueNodeProps | StringValueNode
Optional directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>
Optional fields?: ReadonlyArray<InputValueDefinitionNodeProps | InputValueDefinitionNode>
name: NameNodeProps | NameNode

InputObjectTypeExtensionNodeProps

InputObjectTypeExtensionNodeProps: { directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<InputValueDefinitionNodeProps | InputValueDefinitionNode>; name: NameNodeProps | NameNode }

InputObjectTypeExtensionNode create input

Type declaration

Optional directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>
Optional fields?: ReadonlyArray<InputValueDefinitionNodeProps | InputValueDefinitionNode>
name: NameNodeProps | NameNode

InputValueDefinitionNodeProps

InputValueDefinitionNodeProps: { defaultValue?: GQL.ValueNode; description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; type: TypeNodeProps | GQL.TypeNode }

InputValueDefinitionNode create input

Type declaration

Optional defaultValue?: GQL.ValueNode
Optional description?: StringValueNodeProps | StringValueNode
Optional directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>
name: NameNodeProps | NameNode
type: TypeNodeProps | GQL.TypeNode

IntValueNodeObjProps

IntValueNodeObjProps: { value: string | number }

IntValueNode create input subtype

Type declaration

value: string | number

IntValueNodeProps

IntValueNodeProps: IntValueNodeObjProps | string | number

IntValueNode create input

InterfaceTypeDefinitionNodeProps

InterfaceTypeDefinitionNodeProps: { description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<FieldDefinitionNodeProps | FieldDefinitionNode>; name: NameNodeProps | NameNode }

InterfaceTypeDefinitionNode create input

Type declaration

Optional description?: StringValueNodeProps | StringValueNode
Optional directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>
Optional fields?: ReadonlyArray<FieldDefinitionNodeProps | FieldDefinitionNode>
name: NameNodeProps | NameNode

InterfaceTypeExtensionNodeProps

InterfaceTypeExtensionNodeProps: { directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<FieldDefinitionNodeProps | FieldDefinitionNode>; name: NameNodeProps | NameNode }

InterfaceTypeExtensionNode create input

Type declaration

Optional directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>
Optional fields?: ReadonlyArray<FieldDefinitionNodeProps | FieldDefinitionNode>
name: NameNodeProps | NameNode

ListTypeNodeProps

ListTypeNodeProps: string | TypeNodeProps | GQL.TypeNode

ListTypeNode create input

ListValueNodeProps

ListValueNodeProps: { values: ReadonlyArray<GQL.ValueNode> }

ListValueNode create input

Type declaration

values: ReadonlyArray<GQL.ValueNode>

NameNodeObjProps

NameNodeObjProps: { name: string }

NameNode create input subtype

Type declaration

name: string

NameNodeProps

NameNodeProps: NameNodeObjProps | string

NameNode create input

NamedTypeNodeProps

NamedTypeNodeProps: string | NameNodeProps | NameNode

NamedTypeNode create input

NonNullTypeNodeProps

NonNullTypeNodeProps: string | TypeNodeProps | GQL.TypeNode

NonNullTypeNode create input

ObjectFieldNodeProps

ObjectFieldNodeProps: { name: NameNodeProps | NameNode; value: GQL.ValueNode }

ObjectFieldNode create input

Type declaration

name: NameNodeProps | NameNode
value: GQL.ValueNode

ObjectTypeDefinitionNodeProps

ObjectTypeDefinitionNodeProps: { description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<FieldDefinitionNodeProps | FieldDefinitionNode>; interfaces?: ReadonlyArray<NamedTypeNodeProps | NamedTypeNode>; name: NameNodeProps | NameNode }

ObjectTypeDefinitionNode create input

Type declaration

Optional description?: StringValueNodeProps | StringValueNode
Optional directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>
Optional fields?: ReadonlyArray<FieldDefinitionNodeProps | FieldDefinitionNode>
Optional interfaces?: ReadonlyArray<NamedTypeNodeProps | NamedTypeNode>
name: NameNodeProps | NameNode

ObjectTypeExtensionNodeProps

ObjectTypeExtensionNodeProps: { directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<FieldDefinitionNodeProps | FieldDefinitionNode>; interfaces?: ReadonlyArray<NamedTypeNodeProps | NamedTypeNode>; name: NameNodeProps | NameNode }

ObjectTypeExtensionNode create input

Type declaration

Optional directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>
Optional fields?: ReadonlyArray<FieldDefinitionNodeProps | FieldDefinitionNode>
Optional interfaces?: ReadonlyArray<NamedTypeNodeProps | NamedTypeNode>
name: NameNodeProps | NameNode

ObjectValueNodeProps

ObjectValueNodeProps: { fields: ReadonlyArray<ObjectFieldNode> }

ObjectValueNode create input

Type declaration

fields: ReadonlyArray<ObjectFieldNode>

OperationDefinitionNodeProps

OperationDefinitionNodeProps: { directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name?: NameNodeProps | NameNode; operation: GQL.OperationTypeNode; selections: ReadonlyArray<SelectionNodeProps | GQL.SelectionNode>; variableDefinitions?: ReadonlyArray<VariableDefinitionNodeProps | VariableDefinitionNode> }

OperationDefinitionNode create input

Type declaration

Optional directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>
Optional name?: NameNodeProps | NameNode
operation: GQL.OperationTypeNode
selections: ReadonlyArray<SelectionNodeProps | GQL.SelectionNode>
Optional variableDefinitions?: ReadonlyArray<VariableDefinitionNodeProps | VariableDefinitionNode>

OperationTypeDefinitionNodeProps

OperationTypeDefinitionNodeProps: { operation: GQL.OperationTypeNode; type: NamedTypeNodeProps | NamedTypeNode }

OperationTypeDefinitionNode create input

Type declaration

operation: GQL.OperationTypeNode
type: NamedTypeNodeProps | NamedTypeNode

ScalarTypeDefinitionNodeProps

ScalarTypeDefinitionNodeProps: { description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode }

ScalarTypeDefinitionNode create input

Type declaration

Optional description?: StringValueNodeProps | StringValueNode
Optional directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>
name: NameNodeProps | NameNode

ScalarTypeExtensionNodeProps

ScalarTypeExtensionNodeProps: { directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode }

ScalarTypeExtensionNode create input

Type declaration

Optional directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>
name: NameNodeProps | NameNode

SchemaDefinitionNodeProps

SchemaDefinitionNodeProps: { directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; operationTypes: ReadonlyArray<OperationTypeDefinitionNodeProps | OperationTypeDefinitionNode> }

SchemaDefinitionNode create input

Type declaration

Optional directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>
operationTypes: ReadonlyArray<OperationTypeDefinitionNodeProps | OperationTypeDefinitionNode>

SchemaExtensionNodeProps

SchemaExtensionNodeProps: { directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; operationTypes: ReadonlyArray<OperationTypeDefinitionNodeProps | OperationTypeDefinitionNode> }

SchemaExtensionNode create input

Type declaration

Optional directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>
operationTypes: ReadonlyArray<OperationTypeDefinitionNodeProps | OperationTypeDefinitionNode>

SelectionNodeProps

SelectionNodeProps: FieldNodeProps | WithKind<FieldNodeObjProps, "Field"> | WithKind<FragmentSpreadNodeObjProps, "FragmentSpread"> | WithKind<InlineFragmentNodeProps, "InlineFragment">

SelectionNode create input

SelectionSetNodeProps

SelectionSetNodeProps: { selections: ReadonlyArray<SelectionNodeProps | GQL.SelectionNode> }

SelectionSetNode create input

Type declaration

selections: ReadonlyArray<SelectionNodeProps | GQL.SelectionNode>

StringValueNodeObjProps

StringValueNodeObjProps: { value: string }

StringValueNode create input subtype

Type declaration

value: string

StringValueNodeProps

StringValueNodeProps: StringValueNodeObjProps | string

StringValueNode create input

TypeDefinitionNodeProps

TypeDefinitionNodeProps: WithKind<ObjectTypeDefinitionNodeProps, "ObjectTypeDefinition"> | WithKind<InterfaceTypeDefinitionNodeProps, "InterfaceTypeDefinition"> | WithKind<ScalarTypeDefinitionNodeProps, "ScalarTypeDefinition"> | WithKind<UnionTypeDefinitionNodeProps, "UnionTypeDefinition"> | WithKind<EnumTypeDefinitionNodeProps, "EnumTypeDefinition"> | WithKind<InputObjectTypeDefinitionNodeProps, "InputObjectTypeDefinition">

TypeDefinitionNode create input

TypeExtensionNodeProps

TypeExtensionNodeProps: WithKind<ObjectTypeExtensionNodeProps, "ObjectTypeExtension"> | WithKind<InterfaceTypeExtensionNodeProps, "InterfaceTypeExtension"> | WithKind<ScalarTypeExtensionNodeProps, "ScalarTypeExtension"> | WithKind<UnionTypeExtensionNodeProps, "UnionTypeExtension"> | WithKind<EnumTypeExtensionNodeProps, "EnumTypeExtension"> | WithKind<InputObjectTypeExtensionNodeProps, "InputObjectTypeExtension">

TypeExtensionNode create input

TypeNodeObjProps

TypeNodeObjProps: { list?: undefined | false | true; named: NamedTypeNodeProps | NamedTypeNode; nonNull?: undefined | false | true }

TypeNode create input subtype

Type declaration

Optional list?: undefined | false | true
named: NamedTypeNodeProps | NamedTypeNode
Optional nonNull?: undefined | false | true

TypeNodeProps

TypeNodeProps: TypeNodeObjProps | string

TypeNode create input

TypeSystemDefinitionNodeProps

TypeSystemDefinitionNodeProps: WithKind<SchemaDefinitionNodeProps, "SchemaDefinition"> | WithKind<DirectiveDefinitionNodeProps, "DirectiveDefinition"> | TypeDefinitionNodeProps

TypeSystemDefinitionNode create input

TypeSystemExtensionNodeProps

TypeSystemExtensionNodeProps: WithKind<SchemaExtensionNodeProps, "SchemaExtension"> | TypeExtensionNodeProps

TypeSystemExtensionNode create input

UnionTypeDefinitionNodeProps

UnionTypeDefinitionNodeProps: { description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; types?: ReadonlyArray<NamedTypeNodeProps | NamedTypeNode> }

UnionTypeDefinitionNode create input

Type declaration

Optional description?: StringValueNodeProps | StringValueNode
Optional directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>
name: NameNodeProps | NameNode
Optional types?: ReadonlyArray<NamedTypeNodeProps | NamedTypeNode>

UnionTypeExtensionNodeProps

UnionTypeExtensionNodeProps: { directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; types?: ReadonlyArray<NamedTypeNodeProps | NamedTypeNode> }

UnionTypeExtensionNode create input

Type declaration

Optional directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>
name: NameNodeProps | NameNode
Optional types?: ReadonlyArray<NamedTypeNodeProps | NamedTypeNode>

ValueNodeProps

ValueNodeProps: WithKind<IntValueNodeObjProps, "IntValue"> | WithKind<BooleanValueNodeObjProps, "BooleanValue"> | WithKind<FloatValueNodeObjProps, "FloatValue"> | WithKind<StringValueNodeObjProps, "StringValue"> | WithKind<{}, "NullValue"> | WithKind<VariableNodeObjProps, "Variable"> | WithKind<EnumValueNodeObjProps, "EnumValue"> | WithKind<ListValueNodeProps, "ListValue"> | WithKind<ObjectValueNodeProps, "ObjectValue">

ValueNode create input

VariableDefinitionNodeProps

VariableDefinitionNodeProps: { defaultValue?: GQL.ValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; type: TypeNodeProps | GQL.TypeNode; variable: VariableNodeProps | VariableNode }

VariableDefinitionNode create input

Type declaration

Optional defaultValue?: GQL.ValueNode
Optional directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>
type: TypeNodeProps | GQL.TypeNode
variable: VariableNodeProps | VariableNode

VariableNodeObjProps

VariableNodeObjProps: { name: string }

VariableNode create input subtype

Type declaration

name: string

VariableNodeProps

VariableNodeProps: string | VariableNodeObjProps

VariableNode create input

Helper Type aliases

Argname

Argname: string

ArrayElement

ArrayElement<T>: T extends ReadonlyArray<infer U> ? U : never

Type parameters

ContstructorType

ContstructorType<T>: T extends {} ? U : never

Type parameters

Directivename

Directivename: string

Fieldname

Fieldname: string

Fragmentname

Fragmentname: string

GuardType

GuardType<T>: T extends (o: any) => o is infer U ? U : never

Type parameters

KindToApiMap

KindToApiMap: typeof kindToApiMap

KindToApiType

KindToApiType<K>: K extends keyof typeof kindToApiMap ? ContstructorType<typeof kindToApiMap[K]> : never

Type parameters

KindToNode

KindToNode<K>: K extends keyof KindToNodeMap ? (props: Parameters<KindToNodeMap[K]>[0]) => ReturnType<KindToNodeMap[K]> : never

Type parameters

KindToNodeMap

KindToNodeMap: typeof kindToNodeMap

KindToNodeProps

KindToNodeProps<K>: K extends keyof KindToNodeMap ? Parameters<KindToNodeMap[K]>[0] : never

Type parameters

SDLInput

SDLInput: string | DocumentNode | (string | DocumentNode)[]

Typename

Typename: string

Variablename

Variablename: string

WithKind

WithKind<T, K>: T & { kind: K }

Type parameters

T
K: GQL.KindEnum

Internal Type aliases

DeepMutable

DeepMutable<T>: {}

recursively mark each object property as mutable

Type parameters

Type declaration

KindToAstMapping

KindToAstMapping<N>: {}

Type parameters

N: GQL.ASTNode

Type declaration

Mutable

Mutable<T>: {}

mark each object property as mutable

Type parameters

Type declaration

Primitive

Primitive: string | number | boolean | null

Other Type aliases

InterfaceMixinNode

InterfaceMixinNode: ObjectTypeDefinitionNode | ObjectTypeExtensionNode | InterfaceTypeDefinitionNode | InterfaceTypeExtensionNode

AST Alias Variables

Const arg

arg: argumentNode = AST.argumentNode

Const directive

directive: directiveNode = AST.directiveNode

Const directiveDef

directiveDef: directiveDefinitionNode = AST.directiveDefinitionNode

Const document

document: documentNode = AST.documentNode

Const enumExt

enumExt: enumTypeExtensionNode = AST.enumTypeExtensionNode

Const enumType

enumType: enumTypeDefinitionNode = AST.enumTypeDefinitionNode

Const enumVal

enumVal: enumValueDefinitionNode = AST.enumValueDefinitionNode

Const field

field: fieldNode = AST.fieldNode

Const fieldDef

fieldDef: fieldDefinitionNode = AST.fieldDefinitionNode

Const fragmentDef

fragmentDef: fragmentDefinitionNode = AST.fragmentDefinitionNode

Const fragmentSpread

fragmentSpread: fragmentSpreadNode = AST.fragmentSpreadNode

Const inlineFragment

inlineFragment: inlineFragmentNode = AST.inlineFragmentNode

Const inputObjectExt

inputObjectExt: inputObjectTypeExtensionNode = AST.inputObjectTypeExtensionNode

Const inputType

inputType: inputObjectTypeDefinitionNode = AST.inputObjectTypeDefinitionNode

Const inputVal

inputVal: inputValueDefinitionNode = AST.inputValueDefinitionNode

Const interfaceExt

interfaceExt: interfaceTypeExtensionNode = AST.interfaceTypeExtensionNode

Const interfaceType

interfaceType: interfaceTypeDefinitionNode = AST.interfaceTypeDefinitionNode

Const name

name: nameNode = AST.nameNode

Const objectExt

objectExt: objectTypeExtensionNode = AST.objectTypeExtensionNode

Const objectType

objectType: objectTypeDefinitionNode = AST.objectTypeDefinitionNode

Const operation

operation: operationDefinitionNode = AST.operationDefinitionNode

Const operationType

operationType: operationTypeDefinitionNode = AST.operationTypeDefinitionNode

Const scalarExt

scalarExt: scalarTypeExtensionNode = AST.scalarTypeExtensionNode

Const scalarType

scalarType: scalarTypeDefinitionNode = AST.scalarTypeDefinitionNode

Const schemaDef

schemaDef: schemaDefinitionNode = AST.schemaDefinitionNode

Const schemaExt

schemaExt: schemaExtensionNode = AST.schemaExtensionNode

Const selections

selections: selectionSetNode = AST.selectionSetNode

Const unionExt

unionExt: unionTypeExtensionNode = AST.unionTypeExtensionNode

Const unionType

unionType: unionTypeDefinitionNode = AST.unionTypeDefinitionNode

Const variable

variable: variableDefinitionNode = AST.variableDefinitionNode

API Mixins Functions

argumentsMixin

argumentsMixin(node: ArgumentsMixinNode): ArgumentsMixin

- Defined in src/mixin/arguments.ts:75
Parameters
- node: ArgumentsMixinNode
Returns ArgumentsMixin

defaultValueMixin

defaultValueMixin(node: DefaultValueMixinNode): DefaultValueMixin

- Defined in src/mixin/default-value.ts:41
Parameters
- node: DefaultValueMixinNode
Returns DefaultValueMixin

descriptionMixin

descriptionMixin(node: DescriptionMixinNode): DescriptionMixin

- Defined in src/mixin/description.ts:52
Parameters
- node: DescriptionMixinNode
Returns DescriptionMixin

directivesMixin

directivesMixin(node: DirectivesMixinNode): DirectivesMixin

- Defined in src/mixin/directives.ts:93
Parameters
- node: DirectivesMixinNode
Returns DirectivesMixin

enumValueDefinitionMixin

enumValueDefinitionMixin(node: EnumValueDefinitionMixinNode): EnumValueDefinitionMixin

- Defined in src/mixin/enum-value-definitions.ts:83
Parameters
- node: EnumValueDefinitionMixinNode
Returns EnumValueDefinitionMixin

fieldDefinitionsMixin

fieldDefinitionsMixin(node: FieldDefinitionsMixinNode): FieldDefinitionsMixin

- Defined in src/mixin/field-definition.ts:112
Parameters
- node: FieldDefinitionsMixinNode
Returns FieldDefinitionsMixin

inputValuesAsFieldsMixin

inputValuesAsFieldsMixin(node: InputValuesAsFieldsMixinNode): InputValuesAsFieldsMixin

- Defined in src/mixin/input-values-as-fields.ts:105
Parameters
- node: InputValuesAsFieldsMixinNode
Returns InputValuesAsFieldsMixin

interfacesMixin

interfacesMixin(node: InterfaceMixinNode): InterfacesMixin

- Defined in src/mixin/interfaces.ts:82
Parameters
- node: InterfaceMixinNode
Returns InterfacesMixin

kindAssertionMixin

kindAssertionMixin(node: GQL.ASTNode): KindAssertionMixin

- Defined in src/mixin/kind-assertion.ts:26
Parameters
- node: GQL.ASTNode
Returns KindAssertionMixin

nameMixin

nameMixin(node: NameMixinNode): NameMixin

- Defined in src/mixin/name.ts:43
Parameters
- node: NameMixinNode
Returns NameMixin

nameOptionalMixin

nameOptionalMixin(node: NameOptionalMixinNode): NameOptionalMixin

- Defined in src/mixin/name.ts:75
Parameters
- node: NameOptionalMixinNode
Returns NameOptionalMixin

namedTypeMixin

namedTypeMixin(node: TypeMixinNode): TypeMixin

- Defined in src/mixin/type.ts:106
Parameters
- node: TypeMixinNode
Returns TypeMixin

operationTypeDefinitionMixin

operationTypeDefinitionMixin(node: OperationTypeDefinitionMixinNode): OperationTypeDefinitionMixin

- Defined in src/mixin/operation-type-definition.ts:110
Parameters
- node: OperationTypeDefinitionMixinNode
Returns OperationTypeDefinitionMixin

selectionMixin

selectionMixin(node: SelectionAssertionMixinNode): SelectionAssertionMixin

- Defined in src/mixin/selection-assertion.ts:57
Parameters
- node: SelectionAssertionMixinNode
Returns SelectionAssertionMixin

selectionSetMixin

selectionSetMixin(node: SelectionSetMixinNode): SelectionSetMixin

- Defined in src/mixin/selection-set.ts:259
Parameters
- node: SelectionSetMixinNode
Returns SelectionSetMixin

typeDefinitionAssertionMixin

typeDefinitionAssertionMixin(node: GQL.TypeDefinitionNode): TypeDefinitionAssertionMixin

- Defined in src/mixin/type-assertion.ts:78
Parameters
- node: GQL.TypeDefinitionNode
Returns TypeDefinitionAssertionMixin

typeExtensionAssertionMixin

typeExtensionAssertionMixin(node: GQL.TypeExtensionNode): TypeExtensionAssertionMixin

- Defined in src/mixin/type-assertion.ts:158
Parameters
- node: GQL.TypeExtensionNode
Returns TypeExtensionAssertionMixin

typeMixin

typeMixin(node: TypeMixinNode): TypeMixin

- Defined in src/mixin/type.ts:70
Parameters
- node: TypeMixinNode
Returns TypeMixin

unionTypesMixin

unionTypesMixin(node: UnionTypesMixinNode): UnionTypesMixin

- Defined in src/mixin/union-types.ts:79
Parameters
- node: UnionTypesMixinNode
Returns UnionTypesMixin

variableMixin

variableMixin(node: VariableMixinNode): VariableMixin

- Defined in src/mixin/variable.ts:42
Parameters
- node: VariableMixinNode
Returns VariableMixin

API Public Functions

argumentApi

argumentApi(node: ArgumentNode): ArgumentApi

- Defined in src/api/argument.ts:40
ArgumentApi constructor fn

Parameters
- node: ArgumentNode
Returns ArgumentApi

definitionApi

definitionApi(node: GQL.DefinitionNode): DefinitionApi

- Defined in src/document/definition.ts:98
polymorfic contructor fn for DefinitionNode

Parameters
- node: GQL.DefinitionNode
Returns DefinitionApi

directiveApi

directiveApi(node: DirectiveNode): DirectiveApi

- Defined in src/api/directive.ts:31
DirectiveApi constructor fn

Parameters
- node: DirectiveNode
Returns DirectiveApi

directiveDefinitionApi

directiveDefinitionApi(node: DirectiveDefinitionNode): DirectiveDefinitionApi

- Defined in src/api/directive-definition.ts:82
Parameters
- node: DirectiveDefinitionNode
Returns DirectiveDefinitionApi

documentApi

documentApi(node?: GQL.DocumentNode): DocumentApi

- Defined in src/document/document.ts:755
DocumentSchemaApi constructor fn

Parameters
- Optional node: GQL.DocumentNode
Returns DocumentApi

documentBaseApi

documentBaseApi(node?: GQL.DocumentNode): DocumentBaseApi

- Defined in src/document/document-base.ts:262
DocumentSchemaApi constructor fn

Parameters
- Optional node: GQL.DocumentNode
Returns DocumentBaseApi

enumExtApi

enumExtApi(node: EnumTypeExtensionNode): EnumExtApi

- Defined in src/api/type-extension.ts:154
EnumExtApi constructor fn

Parameters
- node: EnumTypeExtensionNode
Returns EnumExtApi

enumTypeApi

enumTypeApi(node: EnumTypeDefinitionNode): EnumTypeApi

- Defined in src/api/type-definition.ts:161
EnumTypeApi constructor fn

Parameters
- node: EnumTypeDefinitionNode
Returns EnumTypeApi

enumValueDefinitionApi

enumValueDefinitionApi(node: EnumValueDefinitionNode): EnumValueDefinitionApi

- Defined in src/api/enum-value-definition.ts:32
EnumValueDefinitionApi contructor fn

Parameters
- node: EnumValueDefinitionNode
Returns EnumValueDefinitionApi

fieldApi

fieldApi(node: FieldNode): FieldApi

- Defined in src/api/selection.ts:38
FieldApi constructor fn

Parameters
- node: FieldNode
Returns FieldApi

fieldDefinitionApi

fieldDefinitionApi(node: FieldDefinitionNode): FieldDefinitionApi

- Defined in src/api/field-definition.ts:43
FieldDefinitionApi constructor fn

Parameters
- node: FieldDefinitionNode
Returns FieldDefinitionApi

fragmentDefinitionApi

fragmentDefinitionApi(node: FragmentDefinitionNode): FragmentDefinitionApi

- Defined in src/api/fragment-definition.ts:32
FragmentDefinitionApi constructor fn

Parameters
- node: FragmentDefinitionNode
Returns FragmentDefinitionApi

fragmentSpreadApi

fragmentSpreadApi(node: FragmentSpreadNode): FragmentSpreadApi

- Defined in src/api/selection.ts:67
FragmentSpreadApi constructor fn

Parameters
- node: FragmentSpreadNode
Returns FragmentSpreadApi

inlineFragmentApi

inlineFragmentApi(node: InlineFragmentNode): InlineFragmentApi

- Defined in src/api/selection.ts:97
InlineFragmentApi constructor fn

Parameters
- node: InlineFragmentNode
Returns InlineFragmentApi

inputExtApi

inputExtApi(node: InputObjectTypeExtensionNode): InputExtApi

- Defined in src/api/type-extension.ts:184
InputExtApi constructor fn

Parameters
- node: InputObjectTypeExtensionNode
Returns InputExtApi

inputTypeApi

inputTypeApi(node: InputObjectTypeDefinitionNode): InputTypeApi

- Defined in src/api/type-definition.ts:192
InputTypeApi constructor fn

Parameters
- node: InputObjectTypeDefinitionNode
Returns InputTypeApi

inputValueDefinitionApi

inputValueDefinitionApi(node: InputValueDefinitionNode): InputValueDefinitionApi

- Defined in src/api/input-value-definition.ts:43
InputValueApi constructor fn

Parameters
- node: InputValueDefinitionNode
Returns InputValueDefinitionApi

interfaceExtApi

interfaceExtApi(node: InterfaceTypeExtensionNode): InterfaceExtApi

- Defined in src/api/type-extension.ts:65
InterfaceExtApi constructor fn

Parameters
- node: InterfaceTypeExtensionNode
Returns InterfaceExtApi

interfaceTypeApi

interfaceTypeApi(node: InterfaceTypeDefinitionNode): InterfaceTypeApi

- Defined in src/api/type-definition.ts:69
InterfaceTypeApi constructor fn

Parameters
- node: InterfaceTypeDefinitionNode
Returns InterfaceTypeApi

nameApi

nameApi(node: NameNode): NameApi

- Defined in src/api/name.ts:31
NameApi constructor fn

Parameters
- node: NameNode
Returns NameApi

namedTypeApi

namedTypeApi(node: NamedTypeNode): NamedTypeApi

- Defined in src/api/type.ts:147
NamedTypeApi constructor fn

Parameters
- node: NamedTypeNode
Returns NamedTypeApi

objectExtApi

objectExtApi(node: ObjectTypeExtensionNode): ObjectExtApi

- Defined in src/api/type-extension.ts:34
ObjectExtApi constructor fn

Parameters
- node: ObjectTypeExtensionNode
Returns ObjectExtApi

objectTypeApi

objectTypeApi(node: ObjectTypeDefinitionNode): ObjectTypeApi

- Defined in src/api/type-definition.ts:37
ObjectTypeApi constructor fn

Parameters
- node: ObjectTypeDefinitionNode
Returns ObjectTypeApi

operationDefinitionApi

operationDefinitionApi(node: OperationDefinitionNode): OperationDefinitionApi

- Defined in src/api/operation-definition.ts:41
OperationDefinitionApi constructor fn

Parameters
- node: OperationDefinitionNode
Returns OperationDefinitionApi

operationTypeDefinitionApi

operationTypeDefinitionApi(node: OperationTypeDefinitionNode): OperationTypeDefinitionApi

- Defined in src/api/operation-type-definition.ts:51
SchemaDefinitionApi constructor fn

Parameters
- node: OperationTypeDefinitionNode
Returns OperationTypeDefinitionApi

scalarExtApi

scalarExtApi(node: ScalarTypeExtensionNode): ScalarExtApi

- Defined in src/api/type-extension.ts:124
ScalarExtApi constructor fn

Parameters
- node: ScalarTypeExtensionNode
Returns ScalarExtApi

scalarTypeApi

scalarTypeApi(node: ScalarTypeDefinitionNode): ScalarTypeApi

- Defined in src/api/type-definition.ts:130
ScalarTypeApi constructor fn

Parameters
- node: ScalarTypeDefinitionNode
Returns ScalarTypeApi

schemaDefinitionApi

schemaDefinitionApi(node: SchemaDefinitionNode): SchemaDefinitionApi

- Defined in src/api/schema-definition.ts:33
SchemaDefinitionApi constructor fn

Parameters
- node: SchemaDefinitionNode
Returns SchemaDefinitionApi

schemaExtensionApi

schemaExtensionApi(node: GQL.SchemaExtensionNode): SchemaExtensionApi

- Defined in src/api/schema-definition.ts:61
SchemaDefinitionApi constructor fn

Parameters
- node: GQL.SchemaExtensionNode
Returns SchemaExtensionApi

selectionApi

selectionApi(node: GQL.SelectionNode): SelectionApi

- Defined in src/api/selection.ts:129
polymorfic contructor fn for SelectionApi

Parameters
- node: GQL.SelectionNode
Returns SelectionApi

selectionSetApi

selectionSetApi(node: SelectionSetNode): SelectionSetApi

- Defined in src/api/selection-set.ts:30
SelectionSetApi constructor fn

Parameters
- node: SelectionSetNode
Returns SelectionSetApi

typeApi

typeApi(node: GQL.TypeNode): TypeApi

- Defined in src/api/type.ts:113
TypeApi constructor fn

Parameters
- node: GQL.TypeNode
Returns TypeApi

typeDefinitionApi

typeDefinitionApi(node: GQL.TypeDefinitionNode): Api.TypeDefinitonApi

- Defined in src/document/definition.ts:28
polymorfic contructor fn for TypeDefinitonApi

Parameters
- node: GQL.TypeDefinitionNode
Returns Api.TypeDefinitonApi

typeExtensionApi

typeExtensionApi(node: GQL.TypeExtensionNode): Api.TypeExtensionApi

- Defined in src/document/definition.ts:55
polymorfic contructor fn for TypeDefinitonApi

Parameters
- node: GQL.TypeExtensionNode
Returns Api.TypeExtensionApi

unionExtApi

unionExtApi(node: UnionTypeExtensionNode): UnionExtApi

- Defined in src/api/type-extension.ts:95
UnionExtApi constructor fn

Parameters
- node: UnionTypeExtensionNode
Returns UnionExtApi

unionTypeApi

unionTypeApi(node: UnionTypeDefinitionNode): UnionTypeApi

- Defined in src/api/type-definition.ts:100
UnionTypeApi constructor fn

Parameters
- node: UnionTypeDefinitionNode
Returns UnionTypeApi

valueApi

valueApi(node: GQL.ValueNode): ValueApi

- Defined in src/api/value.ts:53
NameApi constructor fn

Parameters
- node: GQL.ValueNode
Returns ValueApi

variableApi

variableApi(node: VariableNode): VariableApi

- Defined in src/api/variable.ts:31
VariableApi constructor fn

Parameters
- node: VariableNode
Returns VariableApi

variableDefinitionApi

variableDefinitionApi(node: VariableDefinitionNode): VariableDefinitionApi

- Defined in src/api/variable-definition.ts:33
NameApi constructor fn

Parameters
- node: VariableDefinitionNode
Returns VariableDefinitionApi

AST Alias Functions

Const mutationType

mutationType(props: RootTypeDefinitionProps): ObjectTypeDefinitionNode

- Defined in src/alias.ts:21
Parameters
- props: RootTypeDefinitionProps
Returns ObjectTypeDefinitionNode

Const queryType

queryType(props: RootTypeDefinitionProps): ObjectTypeDefinitionNode

- Defined in src/alias.ts:15
Parameters
- props: RootTypeDefinitionProps
Returns ObjectTypeDefinitionNode

Const subscriptionType

subscriptionType(props: RootTypeDefinitionProps): ObjectTypeDefinitionNode

- Defined in src/alias.ts:27
Parameters
- props: RootTypeDefinitionProps
Returns ObjectTypeDefinitionNode

AST Guard Functions

iEnumValueNode

iEnumValueNode(node: GQL.ASTNode): node is EnumValueNode

- Defined in src/guards.ts:169
EnumValueNode guard

Parameters
- node: GQL.ASTNode
Returns node is EnumValueNode

isArgumentNode

isArgumentNode(node: GQL.ASTNode): node is ArgumentNode

- Defined in src/guards.ts:71
ArgumentNode guard

Parameters
- node: GQL.ASTNode
Returns node is ArgumentNode

isBooleanValueNode

isBooleanValueNode(node: GQL.ASTNode): node is BooleanValueNode

- Defined in src/guards.ts:151
BooleanValueNode guard

Parameters
- node: GQL.ASTNode
Returns node is BooleanValueNode

isDirectiveDefinitionNode

isDirectiveDefinitionNode(node: GQL.ASTNode): node is DirectiveDefinitionNode

- Defined in src/guards.ts:362
DirectiveDefinitionNode guard

Parameters
- node: GQL.ASTNode
Returns node is DirectiveDefinitionNode

isDirectiveNode

isDirectiveNode(node: GQL.ASTNode): node is DirectiveNode

- Defined in src/guards.ts:209
DirectiveNode guard

Parameters
- node: GQL.ASTNode
Returns node is DirectiveNode

isDocumentNode

isDocumentNode(node: GQL.ASTNode): node is DocumentNode

- Defined in src/guards.ts:26
DocumentNode guard

Parameters
- node: GQL.ASTNode
Returns node is DocumentNode

isEnumTypeDefinitionNode

isEnumTypeDefinitionNode(node: GQL.ASTNode): node is EnumTypeDefinitionNode

- Defined in src/guards.ts:329
EnumTypeDefinitionNode guard

Parameters
- node: GQL.ASTNode
Returns node is EnumTypeDefinitionNode

isEnumTypeExtensionNode

isEnumTypeExtensionNode(node: GQL.ASTNode): node is EnumTypeExtensionNode

- Defined in src/guards.ts:424
EnumTypeExtensionNode guard

Parameters
- node: GQL.ASTNode
Returns node is EnumTypeExtensionNode

isEnumValueDefinitionNode

isEnumValueDefinitionNode(node: GQL.ASTNode): node is EnumValueDefinitionNode

- Defined in src/guards.ts:338
EnumValueDefinitionNode guard

Parameters
- node: GQL.ASTNode
Returns node is EnumValueDefinitionNode

isFieldDefinitionNode

isFieldDefinitionNode(node: GQL.ASTNode): node is FieldDefinitionNode

- Defined in src/guards.ts:293
FieldDefinitionNode guard

Parameters
- node: GQL.ASTNode
Returns node is FieldDefinitionNode

isFieldNode

isFieldNode(node: GQL.ASTNode): node is FieldNode

- Defined in src/guards.ts:62
FieldNode guard

Parameters
- node: GQL.ASTNode
Returns node is FieldNode

isFloatValueNode

isFloatValueNode(node: GQL.ASTNode): node is FloatValueNode

- Defined in src/guards.ts:133
FloatValueNode guard

Parameters
- node: GQL.ASTNode
Returns node is FloatValueNode

isFragmentDefinitionNode

isFragmentDefinitionNode(node: GQL.ASTNode): node is FragmentDefinitionNode

- Defined in src/guards.ts:102
FragmentDefinitionNode guard

Parameters
- node: GQL.ASTNode
Returns node is FragmentDefinitionNode

isFragmentSpreadNode

isFragmentSpreadNode(node: GQL.ASTNode): node is FragmentSpreadNode

- Defined in src/guards.ts:84
FragmentSpreadNode guard

Parameters
- node: GQL.ASTNode
Returns node is FragmentSpreadNode

isInlineFragmentNode

isInlineFragmentNode(node: GQL.ASTNode): node is InlineFragmentNode

- Defined in src/guards.ts:93
InlineFragmentNode guard

Parameters
- node: GQL.ASTNode
Returns node is InlineFragmentNode

isInputObjectTypeDefinitionNode

isInputObjectTypeDefinitionNode(node: GQL.ASTNode): node is InputObjectTypeDefinitionNode

- Defined in src/guards.ts:347
InputObjectTypeDefinitionNode guard

Parameters
- node: GQL.ASTNode
Returns node is InputObjectTypeDefinitionNode

isInputObjectTypeExtensionNode

isInputObjectTypeExtensionNode(node: GQL.ASTNode): node is InputObjectTypeExtensionNode

- Defined in src/guards.ts:433
InputObjectTypeExtensionNode guard

Parameters
- node: GQL.ASTNode
Returns node is InputObjectTypeExtensionNode

isInputValueDefinitionNode

isInputValueDefinitionNode(node: GQL.ASTNode): node is InputValueDefinitionNode

- Defined in src/guards.ts:302
InputValueDefinitionNode guard

Parameters
- node: GQL.ASTNode
Returns node is InputValueDefinitionNode

isIntValueNode

isIntValueNode(node: GQL.ASTNode): node is IntValueNode

- Defined in src/guards.ts:124
IntValueNode guard

Parameters
- node: GQL.ASTNode
Returns node is IntValueNode

isInterfaceTypeDefinitionNode

isInterfaceTypeDefinitionNode(node: GQL.ASTNode): node is InterfaceTypeDefinitionNode

- Defined in src/guards.ts:311
InterfaceTypeDefinitionNode guard

Parameters
- node: GQL.ASTNode
Returns node is InterfaceTypeDefinitionNode

isInterfaceTypeExtensionNode

isInterfaceTypeExtensionNode(node: GQL.ASTNode): node is InterfaceTypeExtensionNode

- Defined in src/guards.ts:406
InterfaceTypeExtensionNode guard

Parameters
- node: GQL.ASTNode
Returns node is InterfaceTypeExtensionNode

isListTypeNode

isListTypeNode(node: GQL.ASTNode): node is ListTypeNode

- Defined in src/guards.ts:231
ListTypeNode guard

Parameters
- node: GQL.ASTNode
Returns node is ListTypeNode

isListValueNode

isListValueNode(node: GQL.ASTNode): node is ListValueNode

- Defined in src/guards.ts:178
ListValueNode guard

Parameters
- node: GQL.ASTNode
Returns node is ListValueNode

isNameNode

isNameNode(node: GQL.ASTNode): node is NameNode

- Defined in src/guards.ts:13
NameNode guard

Parameters
- node: GQL.ASTNode
Returns node is NameNode

isNamedTypeNode

isNamedTypeNode(node: GQL.ASTNode): node is NamedTypeNode

- Defined in src/guards.ts:222
NamedTypeNode guard

Parameters
- node: GQL.ASTNode
Returns node is NamedTypeNode

isNonNullTypeNode

isNonNullTypeNode(node: GQL.ASTNode): node is NonNullTypeNode

- Defined in src/guards.ts:240
NonNullTypeNode guard

Parameters
- node: GQL.ASTNode
Returns node is NonNullTypeNode

isNullValueNode

isNullValueNode(node: GQL.ASTNode): node is NullValueNode

- Defined in src/guards.ts:160
NullValueNode guard

Parameters
- node: GQL.ASTNode
Returns node is NullValueNode

isObjectFieldNode

isObjectFieldNode(node: GQL.ASTNode): node is ObjectFieldNode

- Defined in src/guards.ts:196
ObjectFieldNode guard

Parameters
- node: GQL.ASTNode
Returns node is ObjectFieldNode

isObjectTypeDefinitionNode

isObjectTypeDefinitionNode(node: GQL.ASTNode): node is ObjectTypeDefinitionNode

- Defined in src/guards.ts:284
ObjectTypeDefinitionNode guard

Parameters
- node: GQL.ASTNode
Returns node is ObjectTypeDefinitionNode

isObjectTypeExtensionNode

isObjectTypeExtensionNode(node: GQL.ASTNode): node is ObjectTypeExtensionNode

- Defined in src/guards.ts:397
ObjectTypeExtensionNode guard

Parameters
- node: GQL.ASTNode
Returns node is ObjectTypeExtensionNode

isObjectValueNode

isObjectValueNode(node: GQL.ASTNode): node is ObjectValueNode

- Defined in src/guards.ts:187
ObjectValueNode guard

Parameters
- node: GQL.ASTNode
Returns node is ObjectValueNode

isOperationDefinitionNode

isOperationDefinitionNode(node: GQL.ASTNode): node is OperationDefinitionNode

- Defined in src/guards.ts:35
OperationDefinitionNode guard

Parameters
- node: GQL.ASTNode
Returns node is OperationDefinitionNode

isOperationTypeDefinitionNode

isOperationTypeDefinitionNode(node: GQL.ASTNode): node is OperationTypeDefinitionNode

- Defined in src/guards.ts:262
OperationTypeDefinitionNode guard

Parameters
- node: GQL.ASTNode
Returns node is OperationTypeDefinitionNode

isScalarTypeDefinitionNode

isScalarTypeDefinitionNode(node: GQL.ASTNode): node is ScalarTypeDefinitionNode

- Defined in src/guards.ts:275
ScalarTypeDefinitionNode guard

Parameters
- node: GQL.ASTNode
Returns node is ScalarTypeDefinitionNode

isScalarTypeExtensionNode

isScalarTypeExtensionNode(node: GQL.ASTNode): node is ScalarTypeExtensionNode

- Defined in src/guards.ts:388
ScalarTypeExtensionNode guard

Parameters
- node: GQL.ASTNode
Returns node is ScalarTypeExtensionNode

isSchemaDefinitionNode

isSchemaDefinitionNode(node: GQL.ASTNode): node is SchemaDefinitionNode

- Defined in src/guards.ts:253
SchemaDefinitionNode guard

Parameters
- node: GQL.ASTNode
Returns node is SchemaDefinitionNode

isSchemaExtensionNode

isSchemaExtensionNode(node: GQL.ASTNode): node is GQL.SchemaExtensionNode

- Defined in src/guards.ts:375
SchemaExtensionNode guard

Parameters
- node: GQL.ASTNode
Returns node is GQL.SchemaExtensionNode

isSelectionSetNode

isSelectionSetNode(node: GQL.ASTNode): node is SelectionSetNode

- Defined in src/guards.ts:53
SelectionSetNode guard

Parameters
- node: GQL.ASTNode
Returns node is SelectionSetNode

isStringValueNode

isStringValueNode(node: GQL.ASTNode): node is StringValueNode

- Defined in src/guards.ts:142
StringValueNode guard

Parameters
- node: GQL.ASTNode
Returns node is StringValueNode

isUnionTypeDefinitionNode

isUnionTypeDefinitionNode(node: GQL.ASTNode): node is UnionTypeDefinitionNode

- Defined in src/guards.ts:320
UnionTypeDefinitionNode guard

Parameters
- node: GQL.ASTNode
Returns node is UnionTypeDefinitionNode

isUnionTypeExtensionNode

isUnionTypeExtensionNode(node: GQL.ASTNode): node is UnionTypeExtensionNode

- Defined in src/guards.ts:415
UnionTypeExtensionNode guard

Parameters
- node: GQL.ASTNode
Returns node is UnionTypeExtensionNode

isVariableDefinitionNode

isVariableDefinitionNode(node: GQL.ASTNode): node is VariableDefinitionNode

- Defined in src/guards.ts:44
VariableDefinitionNode guard

Parameters
- node: GQL.ASTNode
Returns node is VariableDefinitionNode

isVariableNode

isVariableNode(node: GQL.ASTNode): node is VariableNode

- Defined in src/guards.ts:115
VariableNode guard

Parameters
- node: GQL.ASTNode
Returns node is VariableNode

AST Node Functions

argumentNode

argumentNode(props: ArgumentNodeProps): ArgumentNode

- Defined in src/ast.ts:248
create ArgumentNode

Parameters
- props: ArgumentNodeProps
Returns ArgumentNode

booleanValueNode

booleanValueNode(props: BooleanValueNodeProps): BooleanValueNode

- Defined in src/ast.ts:477
create BooleanValueNode

Parameters
- props: BooleanValueNodeProps
Returns BooleanValueNode

definitionNode

definitionNode(__namedParameters: { kind: "OperationDefinition" | "FragmentDefinition" | "SchemaDefinition" | "ScalarTypeDefinition" | "ObjectTypeDefinition" | "InterfaceTypeDefinition" | "UnionTypeDefinition" | "EnumTypeDefinition" | "InputObjectTypeDefinition" | "DirectiveDefinition" | "SchemaExtension" | "ScalarTypeExtension" | "ObjectTypeExtension" | "InterfaceTypeExtension" | "UnionTypeExtension" | "EnumTypeExtension" | "InputObjectTypeExtension"; props: props | props | props | props | props | props | props | props | props | props | props | props | props | props | props | props | props }): GQL.DefinitionNode

- Defined in src/ast.ts:1536
create DefinitionNode

Parameters
- __namedParameters: { kind: "OperationDefinition" | "FragmentDefinition" | "SchemaDefinition" | "ScalarTypeDefinition" | "ObjectTypeDefinition" | "InterfaceTypeDefinition" | "UnionTypeDefinition" | "EnumTypeDefinition" | "InputObjectTypeDefinition" | "DirectiveDefinition" | "SchemaExtension" | "ScalarTypeExtension" | "ObjectTypeExtension" | "InterfaceTypeExtension" | "UnionTypeExtension" | "EnumTypeExtension" | "InputObjectTypeExtension"; props: props | props | props | props | props | props | props | props | props | props | props | props | props | props | props | props | props }
  - kind: "OperationDefinition" | "FragmentDefinition" | "SchemaDefinition" | "ScalarTypeDefinition" | "ObjectTypeDefinition" | "InterfaceTypeDefinition" | "UnionTypeDefinition" | "EnumTypeDefinition" | "InputObjectTypeDefinition" | "DirectiveDefinition" | "SchemaExtension" | "ScalarTypeExtension" | "ObjectTypeExtension" | "InterfaceTypeExtension" | "UnionTypeExtension" | "EnumTypeExtension" | "InputObjectTypeExtension"
  - props: props | props | props | props | props | props | props | props | props | props | props | props | props | props | props | props | props
Returns GQL.DefinitionNode

directiveDefinitionNode

directiveDefinitionNode(props: DirectiveDefinitionNodeProps): DirectiveDefinitionNode

- Defined in src/ast.ts:1124
create DirectiveDefinitionNode

Parameters
- props: DirectiveDefinitionNodeProps
Returns DirectiveDefinitionNode

directiveNode

directiveNode(directive: DirectiveNodeProps): DirectiveNode

- Defined in src/ast.ts:624
create DirectiveNode

Parameters
- directive: DirectiveNodeProps
Returns DirectiveNode

documentNode

documentNode(__namedParameters: { definitions: ReadonlyArray<OperationDefinitionNode | FragmentDefinitionNode | SchemaDefinitionNode | ScalarTypeDefinitionNode | ObjectTypeDefinitionNode | InterfaceTypeDefinitionNode | UnionTypeDefinitionNode | EnumTypeDefinitionNode | InputObjectTypeDefinitionNode | DirectiveDefinitionNode | { directives?: ReadonlyArray<DirectiveNode>; kind: "SchemaExtension"; loc?: Location; operationTypes?: ReadonlyArray<OperationTypeDefinitionNode> } | ScalarTypeExtensionNode | ObjectTypeExtensionNode | InterfaceTypeExtensionNode | UnionTypeExtensionNode | EnumTypeExtensionNode | InputObjectTypeExtensionNode | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; operationTypes: ReadonlyArray<OperationTypeDefinitionNodeProps | OperationTypeDefinitionNode> } & { kind: K }) | ({ arguments?: ReadonlyArray<InputValueDefinitionNodeProps | InputValueDefinitionNode>; description?: StringValueNodeProps | StringValueNode; locations: ReadonlyArray<GQL.DirectiveLocationEnum | NameNode>; name: NameNodeProps | NameNode; repeatable?: undefined | false | true } & { kind: K }) | ({ description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<FieldDefinitionNodeProps | FieldDefinitionNode>; interfaces?: ReadonlyArray<NamedTypeNodeProps | NamedTypeNode>; name: NameNodeProps | NameNode } & { kind: K }) | ({ description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<FieldDefinitionNodeProps | FieldDefinitionNode>; name: NameNodeProps | NameNode } & { kind: K }) | ({ description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode } & { kind: K }) | ({ description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; types?: ReadonlyArray<NamedTypeNodeProps | NamedTypeNode> } & { kind: K }) | ({ description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; values?: ReadonlyArray<EnumValueDefinitionNodeProps | EnumValueDefinitionNode> } & { kind: K }) | ({ description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<InputValueDefinitionNodeProps | InputValueDefinitionNode>; name: NameNodeProps | NameNode } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; operationTypes: ReadonlyArray<OperationTypeDefinitionNodeProps | OperationTypeDefinitionNode> } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<FieldDefinitionNodeProps | FieldDefinitionNode>; interfaces?: ReadonlyArray<NamedTypeNodeProps | NamedTypeNode>; name: NameNodeProps | NameNode } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<FieldDefinitionNodeProps | FieldDefinitionNode>; name: NameNodeProps | NameNode } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; types?: ReadonlyArray<NamedTypeNodeProps | NamedTypeNode> } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; values?: ReadonlyArray<EnumValueDefinitionNodeProps | EnumValueDefinitionNode> } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<InputValueDefinitionNodeProps | InputValueDefinitionNode>; name: NameNodeProps | NameNode } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name?: NameNodeProps | NameNode; operation: GQL.OperationTypeNode; selections: ReadonlyArray<SelectionNodeProps | GQL.SelectionNode>; variableDefinitions?: ReadonlyArray<VariableDefinitionNodeProps | VariableDefinitionNode> } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; selections: ReadonlyArray<SelectionNodeProps | GQL.SelectionNode>; typeCondition: NamedTypeNodeProps | NamedTypeNode; variableDefinitions?: ReadonlyArray<VariableDefinitionNodeProps | VariableDefinitionNode> } & { kind: K })> }): DocumentNode

- Defined in src/ast.ts:63
create DocumentNode

Parameters
- __namedParameters: { definitions: ReadonlyArray<OperationDefinitionNode | FragmentDefinitionNode | SchemaDefinitionNode | ScalarTypeDefinitionNode | ObjectTypeDefinitionNode | InterfaceTypeDefinitionNode | UnionTypeDefinitionNode | EnumTypeDefinitionNode | InputObjectTypeDefinitionNode | DirectiveDefinitionNode | { directives?: ReadonlyArray<DirectiveNode>; kind: "SchemaExtension"; loc?: Location; operationTypes?: ReadonlyArray<OperationTypeDefinitionNode> } | ScalarTypeExtensionNode | ObjectTypeExtensionNode | InterfaceTypeExtensionNode | UnionTypeExtensionNode | EnumTypeExtensionNode | InputObjectTypeExtensionNode | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; operationTypes: ReadonlyArray<OperationTypeDefinitionNodeProps | OperationTypeDefinitionNode> } & { kind: K }) | ({ arguments?: ReadonlyArray<InputValueDefinitionNodeProps | InputValueDefinitionNode>; description?: StringValueNodeProps | StringValueNode; locations: ReadonlyArray<GQL.DirectiveLocationEnum | NameNode>; name: NameNodeProps | NameNode; repeatable?: undefined | false | true } & { kind: K }) | ({ description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<FieldDefinitionNodeProps | FieldDefinitionNode>; interfaces?: ReadonlyArray<NamedTypeNodeProps | NamedTypeNode>; name: NameNodeProps | NameNode } & { kind: K }) | ({ description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<FieldDefinitionNodeProps | FieldDefinitionNode>; name: NameNodeProps | NameNode } & { kind: K }) | ({ description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode } & { kind: K }) | ({ description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; types?: ReadonlyArray<NamedTypeNodeProps | NamedTypeNode> } & { kind: K }) | ({ description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; values?: ReadonlyArray<EnumValueDefinitionNodeProps | EnumValueDefinitionNode> } & { kind: K }) | ({ description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<InputValueDefinitionNodeProps | InputValueDefinitionNode>; name: NameNodeProps | NameNode } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; operationTypes: ReadonlyArray<OperationTypeDefinitionNodeProps | OperationTypeDefinitionNode> } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<FieldDefinitionNodeProps | FieldDefinitionNode>; interfaces?: ReadonlyArray<NamedTypeNodeProps | NamedTypeNode>; name: NameNodeProps | NameNode } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<FieldDefinitionNodeProps | FieldDefinitionNode>; name: NameNodeProps | NameNode } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; types?: ReadonlyArray<NamedTypeNodeProps | NamedTypeNode> } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; values?: ReadonlyArray<EnumValueDefinitionNodeProps | EnumValueDefinitionNode> } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<InputValueDefinitionNodeProps | InputValueDefinitionNode>; name: NameNodeProps | NameNode } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name?: NameNodeProps | NameNode; operation: GQL.OperationTypeNode; selections: ReadonlyArray<SelectionNodeProps | GQL.SelectionNode>; variableDefinitions?: ReadonlyArray<VariableDefinitionNodeProps | VariableDefinitionNode> } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; selections: ReadonlyArray<SelectionNodeProps | GQL.SelectionNode>; typeCondition: NamedTypeNodeProps | NamedTypeNode; variableDefinitions?: ReadonlyArray<VariableDefinitionNodeProps | VariableDefinitionNode> } & { kind: K })> }
 - definitions: ReadonlyArray<OperationDefinitionNode | FragmentDefinitionNode | SchemaDefinitionNode | ScalarTypeDefinitionNode | ObjectTypeDefinitionNode | InterfaceTypeDefinitionNode | UnionTypeDefinitionNode | EnumTypeDefinitionNode | InputObjectTypeDefinitionNode | DirectiveDefinitionNode | { directives?: ReadonlyArray<DirectiveNode>; kind: "SchemaExtension"; loc?: Location; operationTypes?: ReadonlyArray<OperationTypeDefinitionNode> } | ScalarTypeExtensionNode | ObjectTypeExtensionNode | InterfaceTypeExtensionNode | UnionTypeExtensionNode | EnumTypeExtensionNode | InputObjectTypeExtensionNode | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; operationTypes: ReadonlyArray<OperationTypeDefinitionNodeProps | OperationTypeDefinitionNode> } & { kind: K }) | ({ arguments?: ReadonlyArray<InputValueDefinitionNodeProps | InputValueDefinitionNode>; description?: StringValueNodeProps | StringValueNode; locations: ReadonlyArray<GQL.DirectiveLocationEnum | NameNode>; name: NameNodeProps | NameNode; repeatable?: undefined | false | true } & { kind: K }) | ({ description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<FieldDefinitionNodeProps | FieldDefinitionNode>; interfaces?: ReadonlyArray<NamedTypeNodeProps | NamedTypeNode>; name: NameNodeProps | NameNode } & { kind: K }) | ({ description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<FieldDefinitionNodeProps | FieldDefinitionNode>; name: NameNodeProps | NameNode } & { kind: K }) | ({ description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode } & { kind: K }) | ({ description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; types?: ReadonlyArray<NamedTypeNodeProps | NamedTypeNode> } & { kind: K }) | ({ description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; values?: ReadonlyArray<EnumValueDefinitionNodeProps | EnumValueDefinitionNode> } & { kind: K }) | ({ description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<InputValueDefinitionNodeProps | InputValueDefinitionNode>; name: NameNodeProps | NameNode } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; operationTypes: ReadonlyArray<OperationTypeDefinitionNodeProps | OperationTypeDefinitionNode> } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<FieldDefinitionNodeProps | FieldDefinitionNode>; interfaces?: ReadonlyArray<NamedTypeNodeProps | NamedTypeNode>; name: NameNodeProps | NameNode } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<FieldDefinitionNodeProps | FieldDefinitionNode>; name: NameNodeProps | NameNode } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; types?: ReadonlyArray<NamedTypeNodeProps | NamedTypeNode> } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; values?: ReadonlyArray<EnumValueDefinitionNodeProps | EnumValueDefinitionNode> } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<InputValueDefinitionNodeProps | InputValueDefinitionNode>; name: NameNodeProps | NameNode } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name?: NameNodeProps | NameNode; operation: GQL.OperationTypeNode; selections: ReadonlyArray<SelectionNodeProps | GQL.SelectionNode>; variableDefinitions?: ReadonlyArray<VariableDefinitionNodeProps | VariableDefinitionNode> } & { kind: K }) | ({ directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; selections: ReadonlyArray<SelectionNodeProps | GQL.SelectionNode>; typeCondition: NamedTypeNodeProps | NamedTypeNode; variableDefinitions?: ReadonlyArray<VariableDefinitionNodeProps | VariableDefinitionNode> } & { kind: K })>
Returns DocumentNode

enumTypeDefinitionNode

enumTypeDefinitionNode(props: EnumTypeDefinitionNodeProps): EnumTypeDefinitionNode

- Defined in src/ast.ts:1020
create EnumTypeDefinitionNode

Parameters
- props: EnumTypeDefinitionNodeProps
Returns EnumTypeDefinitionNode

enumTypeExtensionNode

enumTypeExtensionNode(props: EnumTypeExtensionNodeProps): EnumTypeExtensionNode

- Defined in src/ast.ts:1292
create EnumTypeExtensionNode

Parameters
- props: EnumTypeExtensionNodeProps
Returns EnumTypeExtensionNode

enumValueDefinitionNode

enumValueDefinitionNode(props: EnumValueDefinitionNodeProps): EnumValueDefinitionNode

- Defined in src/ast.ts:1055
create EnumValueDefinitionNode

Parameters
- props: EnumValueDefinitionNodeProps
Returns EnumValueDefinitionNode

enumValueNode

enumValueNode(props: EnumValueNodeProps): EnumValueNode

- Defined in src/ast.ts:524
create EnumValueNode

Parameters
- props: EnumValueNodeProps
Returns EnumValueNode

executableDefinitionNode

executableDefinitionNode(__namedParameters: { kind: "OperationDefinition" | "FragmentDefinition"; props: props | props }): GQL.ExecutableDefinitionNode

- Defined in src/ast.ts:1501
create ExecutableDefinitionNode

Parameters
- __namedParameters: { kind: "OperationDefinition" | "FragmentDefinition"; props: props | props }
  - kind: "OperationDefinition" | "FragmentDefinition"
  - props: props | props
Returns GQL.ExecutableDefinitionNode

fieldDefinitionNode

fieldDefinitionNode(props: FieldDefinitionNodeProps): FieldDefinitionNode

- Defined in src/ast.ts:900
create FieldDefinitionNode

Parameters
- props: FieldDefinitionNodeProps
Returns FieldDefinitionNode

fieldNode

fieldNode(props: FieldNodeProps): FieldNode

- Defined in src/ast.ts:213
create FieldNode

Parameters
- props: FieldNodeProps
Returns FieldNode

floatValueNode

floatValueNode(props: FloatValueNodeProps): FloatValueNode

- Defined in src/ast.ts:416
create FloatValueNode

Parameters
- props: FloatValueNodeProps
Returns FloatValueNode

fragmentDefinitionNode

fragmentDefinitionNode(props: FragmentDefinitionNodeProps): FragmentDefinitionNode

- Defined in src/ast.ts:347
create FragmentDefinitionNode

Parameters
- props: FragmentDefinitionNodeProps
Returns FragmentDefinitionNode

fragmentSpreadNode

fragmentSpreadNode(props: FragmentSpreadNodeProps): FragmentSpreadNode

- Defined in src/ast.ts:283
create FragmentSpreadNode

Parameters
- props: FragmentSpreadNodeProps
Returns FragmentSpreadNode

inlineFragmentNode

inlineFragmentNode(props: InlineFragmentNodeProps): InlineFragmentNode

- Defined in src/ast.ts:317
create InlineFragmentNode

Parameters
- props: InlineFragmentNodeProps
Returns InlineFragmentNode

inputObjectTypeDefinitionNode

inputObjectTypeDefinitionNode(props: InputObjectTypeDefinitionNodeProps): InputObjectTypeDefinitionNode

- Defined in src/ast.ts:1090
create InputObjectTypeDefinitionNode

Parameters
- props: InputObjectTypeDefinitionNodeProps
Returns InputObjectTypeDefinitionNode

inputObjectTypeExtensionNode

inputObjectTypeExtensionNode(props: InputObjectTypeExtensionNodeProps): InputObjectTypeExtensionNode

- Defined in src/ast.ts:1319
create InputObjectTypeExtensionNode

Parameters
- props: InputObjectTypeExtensionNodeProps
Returns InputObjectTypeExtensionNode

inputValueDefinitionNode

inputValueDefinitionNode(props: InputValueDefinitionNodeProps): InputValueDefinitionNode

- Defined in src/ast.ts:932
create InputValueDefinitionNode

Parameters
- props: InputValueDefinitionNodeProps
Returns InputValueDefinitionNode

intValueNode

intValueNode(props: IntValueNodeProps): IntValueNode

- Defined in src/ast.ts:384
create IntValueNode

Parameters
- props: IntValueNodeProps
Returns IntValueNode

interfaceTypeDefinitionNode

interfaceTypeDefinitionNode(props: InterfaceTypeDefinitionNodeProps): InterfaceTypeDefinitionNode

- Defined in src/ast.ts:962
create InterfaceTypeDefinitionNode

Parameters
- props: InterfaceTypeDefinitionNodeProps
Returns InterfaceTypeDefinitionNode

interfaceTypeExtensionNode

interfaceTypeExtensionNode(props: InterfaceTypeExtensionNodeProps): InterfaceTypeExtensionNode

- Defined in src/ast.ts:1238
create InterfaceTypeExtensionNode

Parameters
- props: InterfaceTypeExtensionNodeProps
Returns InterfaceTypeExtensionNode

listTypeNode

listTypeNode(props: ListTypeNodeProps): ListTypeNode

- Defined in src/ast.ts:679
create ListTypeNode

Parameters
- props: ListTypeNodeProps
Returns ListTypeNode

listValueNode

listValueNode(props: ListValueNodeProps): ListValueNode

- Defined in src/ast.ts:547
ListValueNode

Parameters
- props: ListValueNodeProps
Returns ListValueNode

nameNode

nameNode(props: NameNodeProps): NameNode

- Defined in src/ast.ts:38
create NameNode

Parameters
- props: NameNodeProps
Returns NameNode

namedTypeNode

namedTypeNode(props: NamedTypeNodeProps): NamedTypeNode

- Defined in src/ast.ts:656
create NamedTypeNode

Parameters
- props: NamedTypeNodeProps
Returns NamedTypeNode

nonNullTypeNode

nonNullTypeNode(props: NonNullTypeNodeProps): NonNullTypeNode

- Defined in src/ast.ts:702
create NonNullTypeNode

Parameters
- props: NonNullTypeNodeProps
Returns NonNullTypeNode

nullValueNode

nullValueNode(props?: undefined): NullValueNode

- Defined in src/ast.ts:497
create NullValueNode

Parameters
- Optional props: undefined
Returns NullValueNode

objectFieldNode

objectFieldNode(props: ObjectFieldNodeProps): ObjectFieldNode

- Defined in src/ast.ts:590
create ObjectFieldNode

Parameters
- props: ObjectFieldNodeProps
Returns ObjectFieldNode

objectTypeDefinitionNode

objectTypeDefinitionNode(props: ObjectTypeDefinitionNodeProps): ObjectTypeDefinitionNode

- Defined in src/ast.ts:865
create ObjectTypeDefinitionNode

Parameters
- props: ObjectTypeDefinitionNodeProps
Returns ObjectTypeDefinitionNode

objectTypeExtensionNode

objectTypeExtensionNode(props: ObjectTypeExtensionNodeProps): ObjectTypeExtensionNode

- Defined in src/ast.ts:1208
create ObjectTypeExtensionNode

Parameters
- props: ObjectTypeExtensionNodeProps
Returns ObjectTypeExtensionNode

objectValueNode

objectValueNode(props: ObjectValueNodeProps): ObjectValueNode

- Defined in src/ast.ts:568
create ObjectValueNode

Parameters
- props: ObjectValueNodeProps
Returns ObjectValueNode

operationDefinitionNode

operationDefinitionNode(props: OperationDefinitionNodeProps): OperationDefinitionNode

- Defined in src/ast.ts:90
create OperationDefinitionNode

Parameters
- props: OperationDefinitionNodeProps
Returns OperationDefinitionNode

operationTypeDefinitionNode

operationTypeDefinitionNode(props: OperationTypeDefinitionNodeProps): OperationTypeDefinitionNode

- Defined in src/ast.ts:808
create OperationTypeDefinitionNode

Parameters
- props: OperationTypeDefinitionNodeProps
Returns OperationTypeDefinitionNode

scalarTypeDefinitionNode

scalarTypeDefinitionNode(props: ScalarTypeDefinitionNodeProps): ScalarTypeDefinitionNode

- Defined in src/ast.ts:836
create ScalarTypeDefinitionNode

Parameters
- props: ScalarTypeDefinitionNodeProps
Returns ScalarTypeDefinitionNode

scalarTypeExtensionNode

scalarTypeExtensionNode(props: ScalarTypeExtensionNodeProps): ScalarTypeExtensionNode

- Defined in src/ast.ts:1181
create ScalarTypeExtensionNode

Parameters
- props: ScalarTypeExtensionNodeProps
Returns ScalarTypeExtensionNode

schemaDefinitionNode

schemaDefinitionNode(props: SchemaDefinitionNodeProps): SchemaDefinitionNode

- Defined in src/ast.ts:783
create SchemaDefinitionNode

Parameters
- props: SchemaDefinitionNodeProps
Returns SchemaDefinitionNode

schemaExtensionNode

schemaExtensionNode(props: SchemaExtensionNodeProps): GQL.SchemaExtensionNode

- Defined in src/ast.ts:1154
create SchemaExtensionNode

Parameters
- props: SchemaExtensionNodeProps
Returns GQL.SchemaExtensionNode

selectionNode

selectionNode(props: SelectionNodeProps): GQL.SelectionNode

- Defined in src/ast.ts:1573
create SelectionNode

Parameters
- props: SelectionNodeProps
Returns GQL.SelectionNode

selectionSetNode

selectionSetNode(props: SelectionSetNodeProps): SelectionSetNode

- Defined in src/ast.ts:179
create SelectionSetNode

Parameters
- props: SelectionSetNodeProps
Returns SelectionSetNode

stringValueNode

stringValueNode(props: StringValueNodeProps): StringValueNode

- Defined in src/ast.ts:447
create StringValueNode

Parameters
- props: StringValueNodeProps
Returns StringValueNode

typeDefinitionNode

typeDefinitionNode(__namedParameters: { kind: "ScalarTypeDefinition" | "ObjectTypeDefinition" | "InterfaceTypeDefinition" | "UnionTypeDefinition" | "EnumTypeDefinition" | "InputObjectTypeDefinition"; props: props | props | props | props | props | props }): GQL.TypeDefinitionNode

- Defined in src/ast.ts:1367
create TypeDefinitionNode

Parameters
- __namedParameters: { kind: "ScalarTypeDefinition" | "ObjectTypeDefinition" | "InterfaceTypeDefinition" | "UnionTypeDefinition" | "EnumTypeDefinition" | "InputObjectTypeDefinition"; props: props | props | props | props | props | props }
  - kind: "ScalarTypeDefinition" | "ObjectTypeDefinition" | "InterfaceTypeDefinition" | "UnionTypeDefinition" | "EnumTypeDefinition" | "InputObjectTypeDefinition"
  - props: props | props | props | props | props | props
Returns GQL.TypeDefinitionNode

typeExtensionNode

typeExtensionNode(__namedParameters: { kind: "ScalarTypeExtension" | "ObjectTypeExtension" | "InterfaceTypeExtension" | "UnionTypeExtension" | "EnumTypeExtension" | "InputObjectTypeExtension"; props: props | props | props | props | props | props }): GQL.TypeExtensionNode

- Defined in src/ast.ts:1405
create TypeExtensionNode

Parameters
- __namedParameters: { kind: "ScalarTypeExtension" | "ObjectTypeExtension" | "InterfaceTypeExtension" | "UnionTypeExtension" | "EnumTypeExtension" | "InputObjectTypeExtension"; props: props | props | props | props | props | props }
  - kind: "ScalarTypeExtension" | "ObjectTypeExtension" | "InterfaceTypeExtension" | "UnionTypeExtension" | "EnumTypeExtension" | "InputObjectTypeExtension"
  - props: props | props | props | props | props | props
Returns GQL.TypeExtensionNode

typeNode

typeNode(type: TypeNodeProps): GQL.TypeNode

- Defined in src/ast.ts:741
create TypeNode

Parameters
- type: TypeNodeProps
Returns GQL.TypeNode

typeSystemDefinitionNode

typeSystemDefinitionNode(__namedParameters: { kind: "SchemaDefinition" | "ScalarTypeDefinition" | "ObjectTypeDefinition" | "InterfaceTypeDefinition" | "UnionTypeDefinition" | "EnumTypeDefinition" | "InputObjectTypeDefinition" | "DirectiveDefinition"; props: props | props | props | props | props | props | props | props }): GQL.TypeSystemDefinitionNode

- Defined in src/ast.ts:1437
create TypeSystemDefinitionNode

Parameters
- __namedParameters: { kind: "SchemaDefinition" | "ScalarTypeDefinition" | "ObjectTypeDefinition" | "InterfaceTypeDefinition" | "UnionTypeDefinition" | "EnumTypeDefinition" | "InputObjectTypeDefinition" | "DirectiveDefinition"; props: props | props | props | props | props | props | props | props }
  - kind: "SchemaDefinition" | "ScalarTypeDefinition" | "ObjectTypeDefinition" | "InterfaceTypeDefinition" | "UnionTypeDefinition" | "EnumTypeDefinition" | "InputObjectTypeDefinition" | "DirectiveDefinition"
  - props: props | props | props | props | props | props | props | props
Returns GQL.TypeSystemDefinitionNode

typeSystemExtensionNode

typeSystemExtensionNode(__namedParameters: { kind: "SchemaExtension" | "ScalarTypeExtension" | "ObjectTypeExtension" | "InterfaceTypeExtension" | "UnionTypeExtension" | "EnumTypeExtension" | "InputObjectTypeExtension"; props: props | props | props | props | props | props | props }): GQL.TypeSystemExtensionNode

- Defined in src/ast.ts:1469
create TypeSystemExtensionNode

Parameters
- __namedParameters: { kind: "SchemaExtension" | "ScalarTypeExtension" | "ObjectTypeExtension" | "InterfaceTypeExtension" | "UnionTypeExtension" | "EnumTypeExtension" | "InputObjectTypeExtension"; props: props | props | props | props | props | props | props }
  - kind: "SchemaExtension" | "ScalarTypeExtension" | "ObjectTypeExtension" | "InterfaceTypeExtension" | "UnionTypeExtension" | "EnumTypeExtension" | "InputObjectTypeExtension"
  - props: props | props | props | props | props | props | props
Returns GQL.TypeSystemExtensionNode

unionTypeDefinitionNode

unionTypeDefinitionNode(props: UnionTypeDefinitionNodeProps): UnionTypeDefinitionNode

- Defined in src/ast.ts:991
create UnionTypeDefinitionNode

Parameters
- props: UnionTypeDefinitionNodeProps
Returns UnionTypeDefinitionNode

unionTypeExtensionNode

unionTypeExtensionNode(props: UnionTypeExtensionNodeProps): UnionTypeExtensionNode

- Defined in src/ast.ts:1265
create UnionTypeExtensionNode

Parameters
- props: UnionTypeExtensionNodeProps
Returns UnionTypeExtensionNode

valueNode

valueNode(props: ValueNodeProps): GQL.ValueNode

- Defined in src/ast.ts:1625
create ValueNode

Parameters
- props: ValueNodeProps
Returns GQL.ValueNode

variableDefinitionNode

variableDefinitionNode(props: VariableDefinitionNodeProps): VariableDefinitionNode

- Defined in src/ast.ts:121
create VariableDefinitionNode

Parameters
- props: VariableDefinitionNodeProps
Returns VariableDefinitionNode

variableNode

variableNode(props: VariableNodeProps): VariableNode

- Defined in src/ast.ts:154
create VariableNode

Parameters
- props: VariableNodeProps
Returns VariableNode

Helper Functions

cloneDeep

cloneDeep<T>(target: T): T

- Defined in src/utils/clone-deep.ts:6
standard object clone deep fn

Type parameters
- T
Parameters
- target: T
Returns T

getName

getName(input: any): string

- Defined in src/utils/get-name.ts:8
gets name from node or props

Parameters
- input: any
Returns string

kindToApi

kindToApi<K>(kind: K): (node: ASTKindToNode[K]) => KindToApiType<K>

- Defined in src/kind-to-api.ts:96
Type parameters
- K: KindEnum
Parameters
- kind: K
Returns (node: ASTKindToNode[K]) => KindToApiType<K>
- - (node: ASTKindToNode[K]): KindToApiType<K>
 - Parameters
 - node: ASTKindToNode[K]
 Returns KindToApiType<K>

kindToNode

kindToNode<K>(kind: K): (props: Parameters<KindToNodeMap[K]>[0]) => ReturnType<KindToNodeMap[K]>

- Defined in src/kind-to-node.ts:107
Type parameters
- K: keyof KindToNodeMap
Parameters
- kind: K
Returns (props: Parameters<KindToNodeMap[K]>[0]) => ReturnType<KindToNodeMap[K]>
- - (props: Parameters<KindToNodeMap[K]>[0]): ReturnType<KindToNodeMap[K]>
 - Parameters
 - props: Parameters<KindToNodeMap[K]>[0]
 Returns ReturnType<KindToNodeMap[K]>

matchNode

matchNode(main: any, subset: any): boolean

- Defined in src/utils/match-node.ts:8
deep equality of subset

works like jest.matchObject() while skips "loc"

Parameters
- main: any
- subset: any
Returns boolean

nodeToApi

nodeToApi<N>(node: N): KindToApiType<N["kind"]>

- Defined in src/kind-to-api.ts:109
Type parameters
- N: ASTNode
Parameters
- node: N
Returns KindToApiType<N["kind"]>

parseSDL

parseSDL(sdl: SDLInput, options?: ParseOptions): GQL.DefinitionNode[]

- Defined in src/utils/parse-sdl.ts:20
Parameters
- sdl: SDLInput
- Default value options: ParseOptions = DEFAULT_PARSE_OPTIONS
Returns GQL.DefinitionNode[]

Internal Functions

applyNullable

applyNullable<P, N>(fn: (props: P) => N, props?: P): N | undefined

- Defined in src/utils/apply-props.ts:92
just nullable

Type parameters
- P
- N
Parameters
- fn: (props: P) => N
  - - (props: P): N
    - Parameters
      - props: P
      Returns N
- Optional props: P
Returns N | undefined

applyNullableImplicit

applyNullableImplicit<P, N>(fn: (props: P) => N, props: P): N

- Defined in src/utils/apply-props.ts:101
just implicitly nullable

Type parameters
- P
- N
Parameters
- fn: (props: P) => N
  - - (props: P): N
    - Parameters
      - props: P
      Returns N
- props: P
Returns N

applyProps

applyProps<P, N>(fn: (props: P) => N, props: P | N): N

- Defined in src/utils/apply-props.ts:110
implicitly nullable + props or node

Type parameters
- P
- N
Parameters
- fn: (props: P) => N
  - - (props: P): N
    - Parameters
      - props: P
      Returns N
- props: P | N
Returns N

applyPropsArr

applyPropsArr<P, N>(fn: (props: P) => N, props: ReadonlyArray): keyof N[]

- Defined in src/utils/apply-props.ts:119
implicitly nullable + on array + props or node

Type parameters
- P
- N
Parameters
- fn: (props: P) => N
 - - (props: P): N
 - Parameters
 - props: P
 Returns N
- props: ReadonlyArray
Returns keyof N[]

applyPropsCloned

applyPropsCloned<P, N>(fn: (props: P) => N, props: N | P): N

- Defined in src/utils/apply-props.ts:154
implicitly nullable + cloned input

Type parameters
- P
- N
Parameters
- fn: (props: P) => N
  - - (props: P): N
    - Parameters
      - props: P
      Returns N
- props: N | P
Returns N

applyPropsClonedPartial

applyPropsClonedPartial<P, N>(fn: (props: P) => N, props: P | Partial<N | P>): Partial<N>

- Defined in src/utils/apply-props.ts:172
implicitly nullable + cloned input + partial

Type parameters
- P
- N
Parameters
- fn: (props: P) => N
 - - (props: P): N
 - Parameters
 - props: P
 Returns N
- props: P | Partial<N | P>
Returns Partial<N>

applyPropsNullable

applyPropsNullable<P, N>(fn: (props: P) => N, props?: P | N): N | undefined

- Defined in src/utils/apply-props.ts:128
nullable + props or node

Type parameters
- P
- N
Parameters
- fn: (props: P) => N
  - - (props: P): N
    - Parameters
      - props: P
      Returns N
- Optional props: P | N
Returns N | undefined

applyPropsNullableArr

applyPropsNullableArr<P, N>(fn: (props: P) => N, props?: ReadonlyArray): keyof N[] | undefined

- Defined in src/utils/apply-props.ts:137
nullable + on array + props or node

Type parameters
- P
- N
Parameters
- fn: (props: P) => N
 - - (props: P): N
 - Parameters
 - props: P
 Returns N
- Optional props: ReadonlyArray
Returns keyof N[] | undefined

applyPropsPartial

applyPropsPartial<P, N>(fn: (props: P) => N, props: P | Partial): Partial<N>

- Defined in src/utils/apply-props.ts:163
implicitly nullable + partial

Type parameters
- P
- N
Parameters
- fn: (props: P) => N
 - - (props: P): N
 - Parameters
 - props: P
 Returns N
- props: P | Partial
Returns Partial<N>

Const arrayableFn

arrayableFn<A, R>(fn: (arg: A) => R): (Anonymous function)

- Defined in src/utils/apply-props.ts:54
Type parameters
- A
- R
Parameters
- fn: (arg: A) => R
  - - (arg: A): R
    - Parameters
      - arg: A
      Returns R
Returns (Anonymous function)

assertionError

assertionError<K>(kind: K, node: ASTNode): GraphQLError

- Defined in src/utils/errors.ts:23
Type parameters
- K: KindEnum
Parameters
- kind: K
- node: ASTNode
Returns GraphQLError

Const clonedFn

clonedFn<P, N>(fn: (props: P) => N): (Anonymous function)

- Defined in src/utils/apply-props.ts:83
Type parameters
- P
- N
Parameters
- fn: (props: P) => N
  - - (props: P): N
    - Parameters
      - props: P
      Returns N
Returns (Anonymous function)

Const concat

concat<T>(arr: keyof T[], ...els: T[]): keyof T[]

- Defined in src/utils/mutable.ts:34
helper to concat readonly array - they are frozen or smth in graphql

Type parameters
- T
Parameters
- arr: keyof T[]
- Rest ...els: T[]
Returns keyof T[]

Const deepMutable

deepMutable<T>(node: T): DeepMutable<T>

- Defined in src/utils/mutable.ts:27
assert input as `DeepMutable

Type parameters
- T
Parameters
- node: T
Returns DeepMutable<T>

isAstNode

isAstNode<Node>(input: any): input is Node

- Defined in src/utils/apply-props.ts:8
Type parameters
- Node
Parameters
- input: any
Returns input is Node

isPrimitive

isPrimitive(value: any): value is Primitive

- Defined in src/utils/apply-props.ts:20
Parameters
- value: any
Returns value is Primitive

Const lazy

lazy<R>(cb: () => R): () => R

- Defined in src/utils/lazy.ts:4
Type parameters
- R
Parameters
- cb: () => R
  - - (): R
    - Returns R
Returns () => R
- - (): R
  - Returns R

Const mutable

mutable<T>(node: T): Mutable<T>

- Defined in src/utils/mutable.ts:21
assert input as `Mutable

Type parameters
- T
Parameters
- node: T
Returns Mutable<T>

Const nullableFn

nullableFn<A, R>(fn: (arg: A) => R): (Anonymous function)

- Defined in src/utils/apply-props.ts:34
Type parameters
- A
- R
Parameters
- fn: (arg: A) => R
  - - (arg: A): R
    - Parameters
      - arg: A
      Returns R
Returns (Anonymous function)

Const nullableImplicitFn

nullableImplicitFn<A, R>(fn: (arg: A) => R): (Anonymous function)

- Defined in src/utils/apply-props.ts:45
Type parameters
- A
- R
Parameters
- fn: (arg: A) => R
  - - (arg: A): R
    - Parameters
      - arg: A
      Returns R
Returns (Anonymous function)

Const partialFn

partialFn<P, N>(fn: (props: P) => N): (Anonymous function)

- Defined in src/utils/apply-props.ts:68
Type parameters
- P
- N
Parameters
- fn: (props: P) => N
  - - (props: P): N
    - Parameters
      - props: P
      Returns N
Returns (Anonymous function)

Const propsOrNodeFn

propsOrNodeFn<P, N>(fn: (props: P) => N): (Anonymous function)

- Defined in src/utils/apply-props.ts:60
Type parameters
- P
- N
Parameters
- fn: (props: P) => N
  - - (props: P): N
    - Parameters
      - props: P
      Returns N
Returns (Anonymous function)

validateNodeKind

validateNodeKind<K>(kind: K, node: ASTKindToNode[K]): void

- Defined in src/utils/errors.ts:32
Type parameters
- K: KindEnum
Parameters
- kind: K
- node: ASTKindToNode[K]
Returns void

validateNodeKindsArr

validateNodeKindsArr<K>(kinds: K[], node: ASTKindToNode[K]): void

- Defined in src/utils/errors.ts:41
Type parameters
- K: KindEnum
Parameters
- kinds: K[]
- node: ASTKindToNode[K]
Returns void

validationError

validationError<K>(kinds: K | K[], node: ASTNode): GraphQLError

- Defined in src/utils/errors.ts:13
Type parameters
- K: KindEnum
Parameters
- kinds: K | K[]
- node: ASTNode
Returns GraphQLError

API Public Object literals

Const kindToDefinitionApi

kindToDefinitionApi: object

map DefinitionNode kind to api

DirectiveDefinition

DirectiveDefinition: DirectiveDefinitionApi = Api.DirectiveDefinitionApi

FragmentDefinition

FragmentDefinition: FragmentDefinitionApi = Api.FragmentDefinitionApi

OperationDefinition

OperationDefinition: OperationDefinitionApi = Api.OperationDefinitionApi

SchemaDefinition

SchemaDefinition: SchemaDefinitionApi = Api.SchemaDefinitionApi

SchemaExtension

SchemaExtension: SchemaExtensionApi = Api.SchemaExtensionApi

Const kindToSelectionApi

kindToSelectionApi: object

map SelectionNode kind to api

Field

Field: FieldApi = FieldApi

FragmentSpread

FragmentSpread: FragmentSpreadApi = FragmentSpreadApi

InlineFragment

InlineFragment: InlineFragmentApi = InlineFragmentApi

Const kindToTypeDefinitionApi

kindToTypeDefinitionApi: object

map TypeDefinitionNode kind to api

EnumTypeDefinition

EnumTypeDefinition: EnumTypeApi = Api.EnumTypeApi

InputObjectTypeDefinition

InputObjectTypeDefinition: InputTypeApi = Api.InputTypeApi

InterfaceTypeDefinition

InterfaceTypeDefinition: InterfaceTypeApi = Api.InterfaceTypeApi

ObjectTypeDefinition

ObjectTypeDefinition: ObjectTypeApi = Api.ObjectTypeApi

ScalarTypeDefinition

ScalarTypeDefinition: ScalarTypeApi = Api.ScalarTypeApi

UnionTypeDefinition

UnionTypeDefinition: UnionTypeApi = Api.UnionTypeApi

Const kindToTypeExtensionApi

kindToTypeExtensionApi: object

map TypeDefinitionNode kind to api

EnumTypeExtension

EnumTypeExtension: EnumExtApi = Api.EnumExtApi

InputObjectTypeExtension

InputObjectTypeExtension: InputExtApi = Api.InputExtApi

InterfaceTypeExtension

InterfaceTypeExtension: InterfaceExtApi = Api.InterfaceExtApi

ObjectTypeExtension

ObjectTypeExtension: ObjectExtApi = Api.ObjectExtApi

ScalarTypeExtension

ScalarTypeExtension: ScalarExtApi = Api.ScalarExtApi

UnionTypeExtension

UnionTypeExtension: UnionExtApi = Api.UnionExtApi

AST Alias Object literals

Const type

type: object

list

list: listTypeNode = AST.listTypeNode

named

named: namedTypeNode = AST.namedTypeNode

nonNull

nonNull: nonNullTypeNode = AST.nonNullTypeNode

bool

bool(): NamedTypeNode

- Defined in src/alias.ts:125
Returns NamedTypeNode

date

date(): NamedTypeNode

- Defined in src/alias.ts:130
Returns NamedTypeNode

dateTime

dateTime(): NamedTypeNode

- Defined in src/alias.ts:131
Returns NamedTypeNode

float

float(): NamedTypeNode

- Defined in src/alias.ts:124
Returns NamedTypeNode

id

id(): NamedTypeNode

- Defined in src/alias.ts:122
Returns NamedTypeNode

int

int(): NamedTypeNode

- Defined in src/alias.ts:123
Returns NamedTypeNode

json

json(): NamedTypeNode

- Defined in src/alias.ts:129
Returns NamedTypeNode

string

string(): NamedTypeNode

- Defined in src/alias.ts:126
Returns NamedTypeNode

Const value

value: object

bool

bool: booleanValueNode = AST.booleanValueNode

enum

enum: enumValueNode = AST.enumValueNode

float

float: floatValueNode = AST.floatValueNode

int

int: intValueNode = AST.intValueNode

list

list: listValueNode = AST.listValueNode

null

null: nullValueNode = AST.nullValueNode

object

object: objectValueNode = AST.objectValueNode

objectField

objectField: objectFieldNode = AST.objectFieldNode

string

string: stringValueNode = AST.stringValueNode

variable

variable: variableNode = AST.variableNode

AST Node Object literals

Const kindToDefinitionNode

kindToDefinitionNode: object

map DefinitionNode kind to ast factory

Const kindToSelectionNode

kindToSelectionNode: object

map SelectionNode kind to ast factory

Field

Field: fieldNode = fieldNode

FragmentSpread

FragmentSpread: fragmentSpreadNode = fragmentSpreadNode

InlineFragment

InlineFragment: inlineFragmentNode = inlineFragmentNode

Const kindToTypeDefinitionNode

kindToTypeDefinitionNode: object

map TypeDefinitionNode kind to ast factory

EnumTypeDefinition

EnumTypeDefinition: enumTypeDefinitionNode = enumTypeDefinitionNode

InputObjectTypeDefinition

InputObjectTypeDefinition: inputObjectTypeDefinitionNode = inputObjectTypeDefinitionNode

InterfaceTypeDefinition

InterfaceTypeDefinition: interfaceTypeDefinitionNode = interfaceTypeDefinitionNode

ObjectTypeDefinition

ObjectTypeDefinition: objectTypeDefinitionNode = objectTypeDefinitionNode

ScalarTypeDefinition

ScalarTypeDefinition: scalarTypeDefinitionNode = scalarTypeDefinitionNode

UnionTypeDefinition

UnionTypeDefinition: unionTypeDefinitionNode = unionTypeDefinitionNode

Const kindToTypeExecutableDefinitionNode

kindToTypeExecutableDefinitionNode: object

map ExecutableDefinitionNode kind to ast factory

FragmentDefinition

FragmentDefinition: fragmentDefinitionNode = fragmentDefinitionNode

OperationDefinition

OperationDefinition: operationDefinitionNode = operationDefinitionNode

Const kindToTypeExtensionNode

kindToTypeExtensionNode: object

map TypeExtensionNode kind to ast factory

EnumTypeExtension

EnumTypeExtension: enumTypeExtensionNode = enumTypeExtensionNode

InputObjectTypeExtension

InputObjectTypeExtension: inputObjectTypeExtensionNode = inputObjectTypeExtensionNode

InterfaceTypeExtension

InterfaceTypeExtension: interfaceTypeExtensionNode = interfaceTypeExtensionNode

ObjectTypeExtension

ObjectTypeExtension: objectTypeExtensionNode = objectTypeExtensionNode

ScalarTypeExtension

ScalarTypeExtension: scalarTypeExtensionNode = scalarTypeExtensionNode

UnionTypeExtension

UnionTypeExtension: unionTypeExtensionNode = unionTypeExtensionNode

Const kindToTypeSystemDefinitionNode

kindToTypeSystemDefinitionNode: object

map TypeSystemDefinitionNode kind to ast factory

DirectiveDefinition

DirectiveDefinition: directiveDefinitionNode = directiveDefinitionNode

SchemaDefinition

SchemaDefinition: schemaDefinitionNode = schemaDefinitionNode

Const kindToTypeSystemExtensionNode

kindToTypeSystemExtensionNode: object

map TypeSystemExtensionNode kind to ast factory

SchemaExtension

SchemaExtension: schemaExtensionNode = schemaExtensionNode

Const kindToValueNode

kindToValueNode: object

map ValueNode kind to ast factory

BooleanValue

BooleanValue: booleanValueNode = booleanValueNode

EnumValue

EnumValue: enumValueNode = enumValueNode

FloatValue

FloatValue: floatValueNode = floatValueNode

IntValue

IntValue: intValueNode = intValueNode

ListValue

ListValue: listValueNode = listValueNode

NullValue

NullValue: nullValueNode = nullValueNode

ObjectValue

ObjectValue: objectValueNode = objectValueNode

StringValue

StringValue: stringValueNode = stringValueNode

Variable

Variable: variableNode = variableNode

Helper Object literals

Const DEFAULT_PARSE_OPTIONS

DEFAULT_PARSE_OPTIONS: object

experimentalFragmentVariables

experimentalFragmentVariables: true = true

noLocation

noLocation: true = true

Const kindToApiMap

kindToApiMap: object

Argument

Argument: ArgumentApi = Api.ArgumentApi

BooleanValue

BooleanValue: ValueApi = Api.ValueApi

Directive

Directive: DirectiveApi = Api.DirectiveApi

DirectiveDefinition

DirectiveDefinition: DirectiveDefinitionApi = Api.DirectiveDefinitionApi

Document

Document: DocumentApi = DocumentApi

EnumTypeDefinition

EnumTypeDefinition: EnumTypeApi = Api.EnumTypeApi

EnumTypeExtension

EnumTypeExtension: EnumExtApi = Api.EnumExtApi

EnumValue

EnumValue: ValueApi = Api.ValueApi

EnumValueDefinition

EnumValueDefinition: EnumValueDefinitionApi = Api.EnumValueDefinitionApi

Field

Field: FieldApi = Api.FieldApi

FieldDefinition

FieldDefinition: FieldDefinitionApi = Api.FieldDefinitionApi

FloatValue

FloatValue: ValueApi = Api.ValueApi

FragmentDefinition

FragmentDefinition: FragmentDefinitionApi = Api.FragmentDefinitionApi

FragmentSpread

FragmentSpread: FragmentSpreadApi = Api.FragmentSpreadApi

InlineFragment

InlineFragment: InlineFragmentApi = Api.InlineFragmentApi

InputObjectTypeDefinition

InputObjectTypeDefinition: InputTypeApi = Api.InputTypeApi

InputObjectTypeExtension

InputObjectTypeExtension: InputExtApi = Api.InputExtApi

InputValueDefinition

InputValueDefinition: InputValueDefinitionApi = Api.InputValueDefinitionApi

IntValue

IntValue: ValueApi = Api.ValueApi

InterfaceTypeDefinition

InterfaceTypeDefinition: InterfaceTypeApi = Api.InterfaceTypeApi

InterfaceTypeExtension

InterfaceTypeExtension: InterfaceExtApi = Api.InterfaceExtApi

ListType

ListType: TypeApi = Api.TypeApi

ListValue

ListValue: ValueApi = Api.ValueApi

Name

Name: NameApi = Api.NameApi

NamedType

NamedType: TypeApi = Api.TypeApi

NonNullType

NonNullType: TypeApi = Api.TypeApi

NullValue

NullValue: ValueApi = Api.ValueApi

ObjectField

ObjectField: ValueApi = Api.ValueApi

ObjectTypeDefinition

ObjectTypeDefinition: ObjectTypeApi = Api.ObjectTypeApi

ObjectTypeExtension

ObjectTypeExtension: ObjectExtApi = Api.ObjectExtApi

ObjectValue

ObjectValue: ValueApi = Api.ValueApi

OperationDefinition

OperationDefinition: OperationDefinitionApi = Api.OperationDefinitionApi

OperationTypeDefinition

OperationTypeDefinition: OperationDefinitionApi = Api.OperationDefinitionApi

ScalarTypeDefinition

ScalarTypeDefinition: ScalarTypeApi = Api.ScalarTypeApi

ScalarTypeExtension

ScalarTypeExtension: ScalarExtApi = Api.ScalarExtApi

SchemaDefinition

SchemaDefinition: SchemaDefinitionApi = Api.SchemaDefinitionApi

SchemaExtension

SchemaExtension: SchemaExtensionApi = Api.SchemaExtensionApi

SelectionSet

SelectionSet: SelectionSetApi = Api.SelectionSetApi

StringValue

StringValue: ValueApi = Api.ValueApi

UnionTypeDefinition

UnionTypeDefinition: UnionTypeApi = Api.UnionTypeApi

UnionTypeExtension

UnionTypeExtension: UnionExtApi = Api.UnionExtApi

Variable

Variable: VariableApi = Api.VariableApi

VariableDefinition

VariableDefinition: VariableDefinitionApi = Api.VariableDefinitionApi

Const kindToNodeMap

kindToNodeMap: object

Argument

Argument: argumentNode = AST.argumentNode

BooleanValue

BooleanValue: booleanValueNode = AST.booleanValueNode

DefinitionNode

DefinitionNode: definitionNode = AST.definitionNode

Directive

Directive: directiveNode = AST.directiveNode

DirectiveDefinition

DirectiveDefinition: directiveDefinitionNode = AST.directiveDefinitionNode

Document

Document: documentNode = AST.documentNode

EnumTypeDefinition

EnumTypeDefinition: enumTypeDefinitionNode = AST.enumTypeDefinitionNode

EnumTypeExtension

EnumTypeExtension: enumTypeExtensionNode = AST.enumTypeExtensionNode

EnumValue

EnumValue: enumValueNode = AST.enumValueNode

EnumValueDefinition

EnumValueDefinition: enumValueDefinitionNode = AST.enumValueDefinitionNode

ExecutableDefinition

ExecutableDefinition: executableDefinitionNode = AST.executableDefinitionNode

Field

Field: fieldNode = AST.fieldNode

FieldDefinition

FieldDefinition: fieldDefinitionNode = AST.fieldDefinitionNode

FloatValue

FloatValue: floatValueNode = AST.floatValueNode

FragmentDefinition

FragmentDefinition: fragmentDefinitionNode = AST.fragmentDefinitionNode

FragmentSpread

FragmentSpread: fragmentSpreadNode = AST.fragmentSpreadNode

InlineFragment

InlineFragment: inlineFragmentNode = AST.inlineFragmentNode

InputObjectTypeDefinition

InputObjectTypeDefinition: inputObjectTypeDefinitionNode = AST.inputObjectTypeDefinitionNode

InputObjectTypeExtension

InputObjectTypeExtension: inputObjectTypeExtensionNode = AST.inputObjectTypeExtensionNode

InputValueDefinition

InputValueDefinition: inputValueDefinitionNode = AST.inputValueDefinitionNode

IntValue

IntValue: intValueNode = AST.intValueNode

InterfaceTypeDefinition

InterfaceTypeDefinition: interfaceTypeDefinitionNode = AST.interfaceTypeDefinitionNode

InterfaceTypeExtension

InterfaceTypeExtension: interfaceTypeExtensionNode = AST.interfaceTypeExtensionNode

ListType

ListType: listTypeNode = AST.listTypeNode

ListValue

ListValue: listValueNode = AST.listValueNode

Name

Name: nameNode = AST.nameNode

NamedType

NamedType: namedTypeNode = AST.namedTypeNode

NonNullType

NonNullType: nonNullTypeNode = AST.nonNullTypeNode

NullValue

NullValue: nullValueNode = AST.nullValueNode

ObjectField

ObjectField: objectFieldNode = AST.objectFieldNode

ObjectTypeDefinition

ObjectTypeDefinition: objectTypeDefinitionNode = AST.objectTypeDefinitionNode

ObjectTypeExtension

ObjectTypeExtension: objectTypeExtensionNode = AST.objectTypeExtensionNode

ObjectValue

ObjectValue: objectValueNode = AST.objectValueNode

OperationDefinition

OperationDefinition: operationDefinitionNode = AST.operationDefinitionNode

OperationTypeDefinition

OperationTypeDefinition: operationTypeDefinitionNode = AST.operationTypeDefinitionNode

ScalarTypeDefinition

ScalarTypeDefinition: scalarTypeDefinitionNode = AST.scalarTypeDefinitionNode

ScalarTypeExtension

ScalarTypeExtension: scalarTypeExtensionNode = AST.scalarTypeExtensionNode

SchemaDefinition

SchemaDefinition: schemaDefinitionNode = AST.schemaDefinitionNode

SchemaExtension

SchemaExtension: schemaExtensionNode = AST.schemaExtensionNode

SelectionNode

SelectionNode: selectionNode = AST.selectionNode

SelectionSet

SelectionSet: selectionSetNode = AST.selectionSetNode

StringValue

StringValue: stringValueNode = AST.stringValueNode

TypeDefinition

TypeDefinition: typeDefinitionNode = AST.typeDefinitionNode

TypeExtension

TypeExtension: typeExtensionNode = AST.typeExtensionNode

TypeSystemDefinition

TypeSystemDefinition: typeSystemDefinitionNode = AST.typeSystemDefinitionNode

TypeSystemExtension

TypeSystemExtension: typeSystemExtensionNode = AST.typeSystemExtensionNode

UnionTypeDefinition

UnionTypeDefinition: unionTypeDefinitionNode = AST.unionTypeDefinitionNode

UnionTypeExtension

UnionTypeExtension: unionTypeExtensionNode = AST.unionTypeExtensionNode

ValueNode

ValueNode: valueNode = AST.valueNode

Variable

Variable: variableNode = AST.variableNode

VariableDefinition

VariableDefinition: variableDefinitionNode = AST.variableDefinitionNode

Index

API Mixins Classes

API Public Classes

Internal Classes

Internal Interfaces

API Mixins Type aliases

API Public Type aliases

AST Alias Type aliases

AST Node Type aliases

Helper Type aliases

Internal Type aliases

Other Type aliases

AST Alias Variables

API Mixins Functions

API Public Functions

AST Alias Functions

AST Guard Functions

AST Node Functions

Helper Functions

Internal Functions

API Public Object literals

AST Alias Object literals

AST Node Object literals

Helper Object literals

API Mixins Type aliases

ArgumentsMixinNode

DefaultValueMixinNode

DescriptionMixinNode

DirectivesMixinNode

EnumValueDefinitionMixinNode

FieldDefinitionsMixinNode

InputValuesAsArgumentsMixinNode

InputValuesAsFieldsMixinNode

NameMixinNode

NameOptionalMixinNode

NamedTypeMixinNode

OperationTypeDefinitionMixinNode

SelectionAssertionMixinNode

SelectionSetMixinNode

TypeMixinNode

UnionTypesMixinNode

VariableMixinNode

API Public Type aliases

DefinitionApi

SelectionApi

TypeDefinitonApi

TypeExtensionApi

AST Alias Type aliases

RootTypeDefinitionProps

AST Node Type aliases

ArgumentNodeProps

Type declaration

name: NameNodeProps | NameNode

value: GQL.ValueNode

BooleanValueNodeObjProps

Type declaration

value: boolean | string | number

BooleanValueNodeProps

DefinitionNodeProps

DirectiveDefinitionNodeProps

Type declaration

Optional arguments?: ReadonlyArray<InputValueDefinitionNodeProps | InputValueDefinitionNode>

Optional description?: StringValueNodeProps | StringValueNode

locations: ReadonlyArray<GQL.DirectiveLocationEnum | NameNode>

name: NameNodeProps | NameNode

Optional repeatable?: undefined | false | true

DirectiveNodeObjProps

Type declaration

Optional arguments?: ReadonlyArray<ArgumentNode | ArgumentNodeProps>

name: NameNodeProps | NameNode

DirectiveNodeProps

DocumentNodeProps

Type declaration

definitions: ReadonlyArray<DefinitionNodeProps | GQL.DefinitionNode>

EnumTypeDefinitionNodeProps

Type declaration

Optional description?: StringValueNodeProps | StringValueNode

Optional directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>

name: NameNodeProps | NameNode

Optional values?: ReadonlyArray<EnumValueDefinitionNodeProps | EnumValueDefinitionNode>