Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DocumentApi

API for GraphQL DocumentNode with schema

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • Default value node: DocumentNode = Ast.documentNode({ definitions: [] })

    Returns DocumentApi

Properties

Readonly _definitions

_definitions: Crud<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, EnumTypeApi | InputTypeApi | InterfaceTypeApi | ObjectTypeApi | ScalarTypeApi | UnionTypeApi | EnumExtApi | InputExtApi | InterfaceExtApi | ObjectExtApi | ScalarExtApi | UnionExtApi | OperationDefinitionApi | FragmentDefinitionApi | DirectiveDefinitionApi | SchemaDefinitionApi | SchemaExtensionApi, ({ 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 }), undefined | string> = new Crud({parent: this.node,key: 'definitions',api: definitionApi,factory: Ast.definitionNode,matcher: (n): string | undefined => ('name' in n ? n.name?.value : undefined),})

Readonly _directiveDefinitions

_directiveDefinitions: Crud<DirectiveDefinitionNode, DirectiveDefinitionApi, { arguments?: ReadonlyArray<InputValueDefinitionNodeProps | InputValueDefinitionNode>; description?: StringValueNodeProps | StringValueNode; locations: ReadonlyArray<GQL.DirectiveLocationEnum | NameNode>; name: NameNodeProps | NameNode; repeatable?: undefined | false | true }, string> = new Crud({parent: this.node,key: 'definitions',api: Api.directiveDefinitionApi,factory: Ast.directiveDefinitionNode,matcher: (n): Directivename => n.name.value,kindFilter: [Kind.DIRECTIVE_DEFINITION],})

Readonly _enumExts

_enumExts: Crud<EnumTypeExtensionNode, EnumExtApi, { directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; values?: ReadonlyArray<EnumValueDefinitionNodeProps | EnumValueDefinitionNode> }, string> = new Crud({parent: this.node,key: 'definitions',api: Api.enumExtApi,factory: Ast.enumTypeExtensionNode,matcher: (n): Typename => n.name.value,kindFilter: [Kind.ENUM_TYPE_EXTENSION],})

Readonly _enumTypes

_enumTypes: Crud<EnumTypeDefinitionNode, EnumTypeApi, { description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; values?: ReadonlyArray<EnumValueDefinitionNodeProps | EnumValueDefinitionNode> }, string> = new Crud({parent: this.node,key: 'definitions',api: Api.enumTypeApi,factory: Ast.enumTypeDefinitionNode,matcher: (n): Typename => n.name.value,kindFilter: [Kind.ENUM_TYPE_DEFINITION],})

Readonly _fragmentDefinitions

_fragmentDefinitions: Crud<FragmentDefinitionNode, FragmentDefinitionApi, { directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; selections: ReadonlyArray<SelectionNodeProps | GQL.SelectionNode>; typeCondition: NamedTypeNodeProps | NamedTypeNode; variableDefinitions?: ReadonlyArray<VariableDefinitionNodeProps | VariableDefinitionNode> }, string> = new Crud({parent: this.node,key: 'definitions',api: Api.fragmentDefinitionApi,factory: Ast.fragmentDefinitionNode,matcher: (n): Fragmentname => n.name.value,kindFilter: [Kind.FRAGMENT_DEFINITION],})

Readonly _inputExts

_inputExts: Crud<InputObjectTypeExtensionNode, InputExtApi, { directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<InputValueDefinitionNodeProps | InputValueDefinitionNode>; name: NameNodeProps | NameNode }, string> = new Crud({parent: this.node,key: 'definitions',api: Api.inputExtApi,factory: Ast.inputObjectTypeExtensionNode,matcher: (n): Typename => n.name.value,kindFilter: [Kind.INPUT_OBJECT_TYPE_EXTENSION],})

Readonly _inputTypes

_inputTypes: Crud<InputObjectTypeDefinitionNode, InputTypeApi, { description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<InputValueDefinitionNodeProps | InputValueDefinitionNode>; name: NameNodeProps | NameNode }, string> = new Crud({parent: this.node,key: 'definitions',api: Api.inputTypeApi,factory: Ast.inputObjectTypeDefinitionNode,matcher: (n): Typename => n.name.value,kindFilter: [Kind.INPUT_OBJECT_TYPE_DEFINITION],})

Readonly _interfaceExts

_interfaceExts: Crud<InterfaceTypeExtensionNode, InterfaceExtApi, { directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<FieldDefinitionNodeProps | FieldDefinitionNode>; name: NameNodeProps | NameNode }, string> = new Crud({parent: this.node,key: 'definitions',api: Api.interfaceExtApi,factory: Ast.interfaceTypeExtensionNode,matcher: (n): Typename => n.name.value,kindFilter: [Kind.INTERFACE_TYPE_EXTENSION],})

Readonly _interfaceTypes

_interfaceTypes: Crud<InterfaceTypeDefinitionNode, InterfaceTypeApi, { description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<FieldDefinitionNodeProps | FieldDefinitionNode>; name: NameNodeProps | NameNode }, string> = new Crud({parent: this.node,key: 'definitions',api: Api.interfaceTypeApi,factory: Ast.interfaceTypeDefinitionNode,matcher: (n): Typename => n.name.value,kindFilter: [Kind.INTERFACE_TYPE_DEFINITION],})

Readonly _objectExts

_objectExts: Crud<ObjectTypeExtensionNode, ObjectExtApi, { directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<FieldDefinitionNodeProps | FieldDefinitionNode>; interfaces?: ReadonlyArray<NamedTypeNodeProps | NamedTypeNode>; name: NameNodeProps | NameNode }, string> = new Crud({parent: this.node,key: 'definitions',api: Api.objectExtApi,factory: Ast.objectTypeExtensionNode,matcher: (n): Typename => n.name.value,kindFilter: [Kind.OBJECT_TYPE_EXTENSION],})

Readonly _objectTypes

_objectTypes: Crud<ObjectTypeDefinitionNode, ObjectTypeApi, { description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; fields?: ReadonlyArray<FieldDefinitionNodeProps | FieldDefinitionNode>; interfaces?: ReadonlyArray<NamedTypeNodeProps | NamedTypeNode>; name: NameNodeProps | NameNode }, string> = new Crud({parent: this.node,key: 'definitions',api: Api.objectTypeApi,factory: Ast.objectTypeDefinitionNode,matcher: (n): Typename => n.name.value,kindFilter: [Kind.OBJECT_TYPE_DEFINITION],})

Readonly _operationDefinitions

_operationDefinitions: Crud<OperationDefinitionNode, OperationDefinitionApi, { directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name?: NameNodeProps | NameNode; operation: GQL.OperationTypeNode; selections: ReadonlyArray<SelectionNodeProps | GQL.SelectionNode>; variableDefinitions?: ReadonlyArray<VariableDefinitionNodeProps | VariableDefinitionNode> }, undefined | string> = new Crud({parent: this.node,key: 'definitions',api: Api.operationDefinitionApi,factory: Ast.operationDefinitionNode,matcher: (n): string | undefined => n.name?.value,kindFilter: [Kind.OPERATION_DEFINITION],})

Readonly _scalarExts

_scalarExts: Crud<ScalarTypeExtensionNode, ScalarExtApi, { directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode }, string> = new Crud({parent: this.node,key: 'definitions',api: Api.scalarExtApi,factory: Ast.scalarTypeExtensionNode,matcher: (n): Typename => n.name.value,kindFilter: [Kind.SCALAR_TYPE_EXTENSION],})

Readonly _scalarTypes

_scalarTypes: Crud<ScalarTypeDefinitionNode, ScalarTypeApi, { description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode }, string> = new Crud({parent: this.node,key: 'definitions',api: Api.scalarTypeApi,factory: Ast.scalarTypeDefinitionNode,matcher: (n): Typename => n.name.value,kindFilter: [Kind.SCALAR_TYPE_DEFINITION],})

Readonly _typeDefinitions

_typeDefinitions: Crud<ScalarTypeDefinitionNode | ObjectTypeDefinitionNode | InterfaceTypeDefinitionNode | UnionTypeDefinitionNode | EnumTypeDefinitionNode | InputObjectTypeDefinitionNode, EnumTypeApi | InputTypeApi | InterfaceTypeApi | ObjectTypeApi | ScalarTypeApi | UnionTypeApi, ({ 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 }), string> = new Crud({parent: this.node,key: 'definitions',api: typeDefinitionApi,factory: Ast.typeDefinitionNode,matcher: (n): Typename => n.name.value,kindFilter: [Kind.OBJECT_TYPE_DEFINITION,Kind.INPUT_OBJECT_TYPE_DEFINITION,Kind.SCALAR_TYPE_DEFINITION,Kind.ENUM_TYPE_DEFINITION,Kind.UNION_TYPE_DEFINITION,Kind.INPUT_OBJECT_TYPE_DEFINITION,],})

Readonly _typeExtensions

_typeExtensions: Crud<ScalarTypeExtensionNode | ObjectTypeExtensionNode | InterfaceTypeExtensionNode | UnionTypeExtensionNode | EnumTypeExtensionNode | InputObjectTypeExtensionNode, EnumExtApi | InputExtApi | InterfaceExtApi | ObjectExtApi | ScalarExtApi | UnionExtApi, ({ 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 }), string> = new Crud({parent: this.node,key: 'definitions',api: typeExtensionApi,factory: Ast.typeExtensionNode,matcher: (n): Typename => n.name.value,kindFilter: [Kind.OBJECT_TYPE_EXTENSION,Kind.INPUT_OBJECT_TYPE_EXTENSION,Kind.SCALAR_TYPE_EXTENSION,Kind.ENUM_TYPE_EXTENSION,Kind.UNION_TYPE_EXTENSION,Kind.INPUT_OBJECT_TYPE_EXTENSION,],})

Readonly _unionExts

_unionExts: Crud<UnionTypeExtensionNode, UnionExtApi, { directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; types?: ReadonlyArray<NamedTypeNodeProps | NamedTypeNode> }, string> = new Crud({parent: this.node,key: 'definitions',api: Api.unionExtApi,factory: Ast.unionTypeExtensionNode,matcher: (n): Typename => n.name.value,kindFilter: [Kind.UNION_TYPE_EXTENSION],})

Readonly _unionTypes

_unionTypes: Crud<UnionTypeDefinitionNode, UnionTypeApi, { description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; types?: ReadonlyArray<NamedTypeNodeProps | NamedTypeNode> }, string> = new Crud({parent: this.node,key: 'definitions',api: Api.unionTypeApi,factory: Ast.unionTypeDefinitionNode,matcher: (n): Typename => n.name.value,kindFilter: [Kind.UNION_TYPE_DEFINITION],})

Readonly node

node: DocumentNode

Accessors

typeMap

  • get typeMap(): Map<Typename, GQL.TypeDefinitionNode>

Methods

addSDL

  • addSDL(sdl: SDLInput, options?: ParseOptions): this
  • add more typedefs

    Parameters

    • sdl: SDLInput
    • Default value options: ParseOptions = DEFAULT_PARSE_OPTIONS

    Returns this

clone

  • Returns DocumentApi

createDirective

  • createDirective(props: DirectiveDefinitionNode | Ast.DirectiveDefinitionNodeProps): this
  • Parameters

    • props: DirectiveDefinitionNode | Ast.DirectiveDefinitionNodeProps

    Returns this

createEnumExt

  • createEnumExt(props: Ast.EnumTypeDefinitionNodeProps | EnumTypeDefinitionNode): this
  • Parameters

    • props: Ast.EnumTypeDefinitionNodeProps | EnumTypeDefinitionNode

    Returns this

createEnumType

  • createEnumType(props: Ast.EnumTypeDefinitionNodeProps | EnumTypeDefinitionNode): this
  • Parameters

    • props: Ast.EnumTypeDefinitionNodeProps | EnumTypeDefinitionNode

    Returns this

createExt

  • Parameters

    Returns this

createFragment

  • createFragment(props: Ast.FragmentDefinitionNodeProps | FragmentDefinitionNode): this
  • Parameters

    • props: Ast.FragmentDefinitionNodeProps | FragmentDefinitionNode

    Returns this

createInputExt

  • createInputExt(props: Ast.InputObjectTypeDefinitionNodeProps | InputObjectTypeDefinitionNode): this
  • Parameters

    • props: Ast.InputObjectTypeDefinitionNodeProps | InputObjectTypeDefinitionNode

    Returns this

createInputType

  • createInputType(props: Ast.InputObjectTypeDefinitionNodeProps | InputObjectTypeDefinitionNode): this
  • Parameters

    • props: Ast.InputObjectTypeDefinitionNodeProps | InputObjectTypeDefinitionNode

    Returns this

createInterfaceExt

  • createInterfaceExt(props: Ast.InterfaceTypeDefinitionNodeProps | InterfaceTypeDefinitionNode): this
  • Parameters

    • props: Ast.InterfaceTypeDefinitionNodeProps | InterfaceTypeDefinitionNode

    Returns this

createInterfaceType

  • createInterfaceType(props: Ast.InterfaceTypeDefinitionNodeProps | InterfaceTypeDefinitionNode): this
  • Parameters

    • props: Ast.InterfaceTypeDefinitionNodeProps | InterfaceTypeDefinitionNode

    Returns this

createObjectExt

  • createObjectExt(props: Ast.ObjectTypeDefinitionNodeProps | ObjectTypeDefinitionNode): this
  • Parameters

    • props: Ast.ObjectTypeDefinitionNodeProps | ObjectTypeDefinitionNode

    Returns this

createObjectType

  • createObjectType(props: Ast.ObjectTypeDefinitionNodeProps | ObjectTypeDefinitionNode): this
  • Parameters

    • props: Ast.ObjectTypeDefinitionNodeProps | ObjectTypeDefinitionNode

    Returns this

createOperation

  • createOperation(props: Ast.OperationDefinitionNodeProps | OperationDefinitionNode): this
  • Parameters

    • props: Ast.OperationDefinitionNodeProps | OperationDefinitionNode

    Returns this

createScalarExt

  • createScalarExt(props: Ast.ScalarTypeDefinitionNodeProps | ScalarTypeDefinitionNode): this
  • Parameters

    • props: Ast.ScalarTypeDefinitionNodeProps | ScalarTypeDefinitionNode

    Returns this

createScalarType

  • createScalarType(props: Ast.ScalarTypeDefinitionNodeProps | ScalarTypeDefinitionNode): this
  • Parameters

    • props: Ast.ScalarTypeDefinitionNodeProps | ScalarTypeDefinitionNode

    Returns this

createSchemaDefinition

  • createSchemaDefinition(props: Ast.SchemaDefinitionNodeProps): this
  • Parameters

    • props: Ast.SchemaDefinitionNodeProps

    Returns this

createSchemaExtension

  • createSchemaExtension(props: Ast.SchemaExtensionNodeProps): this
  • Parameters

    • props: Ast.SchemaExtensionNodeProps

    Returns this

createType

  • Parameters

    Returns this

createUnionExt

  • createUnionExt(props: Ast.UnionTypeDefinitionNodeProps | UnionTypeDefinitionNode): this
  • Parameters

    • props: Ast.UnionTypeDefinitionNodeProps | UnionTypeDefinitionNode

    Returns this

createUnionType

  • createUnionType(props: Ast.UnionTypeDefinitionNodeProps | UnionTypeDefinitionNode): this
  • Parameters

    • props: Ast.UnionTypeDefinitionNodeProps | UnionTypeDefinitionNode

    Returns this

getAllEnumExts

  • Returns EnumExtApi[]

getAllEnumTypes

  • Returns EnumTypeApi[]

getAllExts

  • getAllExts(): Api.TypeExtensionApi[]
  • Returns Api.TypeExtensionApi[]

getAllFragments

getAllInputExts

  • Returns InputExtApi[]

getAllInputTypes

  • Returns InputTypeApi[]

getAllInterfaceExts

getAllInterfaceTypes

getAllObjectExts

  • Returns ObjectExtApi[]

getAllObjectTypes

  • Returns ObjectTypeApi[]

getAllOperations

getAllScalarExts

  • Returns ScalarExtApi[]

getAllScalarTypes

  • Returns ScalarTypeApi[]

getAllTypes

  • getAllTypes(): Api.TypeDefinitonApi[]
  • Returns Api.TypeDefinitonApi[]

getAllUnionExts

  • Returns UnionExtApi[]

getAllUnionTypes

  • Returns UnionTypeApi[]

getDirective

getDirectiveNames

  • Returns Directivename[]

getDirectives

getEnumExt

  • Parameters

    Returns EnumExtApi

getEnumType

getExt

  • getExt(typename: Typename): Api.TypeExtensionApi
  • Parameters

    Returns Api.TypeExtensionApi

getFragment

getFragmentNames

  • Returns Fragmentname[]

getInputExt

getInputType

getInterfaceExt

getInterfaceType

getMutation

  • Returns ObjectTypeApi | undefined

getObjectExt

getObjectType

getOperation

  • Parameters

    • Optional operationname: undefined | string

    Returns OperationDefinitionApi

getOperationNames

  • getOperationNames(): (undefined | string)[]
  • Returns (undefined | string)[]

getOperationRoot

  • getOperationRoot(operation: GQL.OperationTypeNode): ObjectTypeApi | undefined
  • Parameters

    • operation: GQL.OperationTypeNode

    Returns ObjectTypeApi | undefined

getQuery

  • Returns ObjectTypeApi | undefined

getScalarExt

getScalarType

getSchemaDefinition

getSchemaExtension

getSubscription

  • Returns ObjectTypeApi | undefined

getType

  • getType(typename: Typename): Api.TypeDefinitonApi
  • Parameters

    Returns Api.TypeDefinitonApi

getUnionExt

getUnionType

hasDirective

  • Parameters

    Returns boolean

hasExt

  • Parameters

    Returns boolean

hasFragment

  • Parameters

    Returns boolean

hasOperation

  • hasOperation(operationname?: undefined | string): boolean
  • Parameters

    • Optional operationname: undefined | string

    Returns boolean

hasSchemaDefinition

  • hasSchemaDefinition(): boolean
  • Returns boolean

hasSchemaExtension

  • hasSchemaExtension(): boolean
  • Returns boolean

hasType

  • Parameters

    Returns boolean

removeDirective

  • Parameters

    Returns this

removeEnumExt

  • removeEnumExt(typename: Typename): this
  • Parameters

    Returns this

removeEnumType

  • removeEnumType(typename: Typename): this
  • Parameters

    Returns this

removeExt

  • Parameters

    Returns this

removeFragment

  • Parameters

    Returns this

removeInputExt

  • removeInputExt(typename: Typename): this
  • Parameters

    Returns this

removeInputType

  • removeInputType(typename: Typename): this
  • Parameters

    Returns this

removeInterfaceExt

  • removeInterfaceExt(typename: Typename): this
  • Parameters

    Returns this

removeInterfaceType

  • removeInterfaceType(typename: Typename): this
  • Parameters

    Returns this

removeObjectExt

  • removeObjectExt(typename: Typename): this
  • Parameters

    Returns this

removeObjectType

  • removeObjectType(typename: Typename): this
  • Parameters

    Returns this

removeOperation

  • removeOperation(operationname: string | undefined): this
  • Parameters

    • operationname: string | undefined

    Returns this

removeScalarExt

  • removeScalarExt(typename: Typename): this
  • Parameters

    Returns this

removeScalarType

  • removeScalarType(typename: Typename): this
  • Parameters

    Returns this

removeSchemaDefinition

  • removeSchemaDefinition(): this
  • Returns this

removeSchemaExtension

  • removeSchemaExtension(): this
  • Returns this

removeType

  • Parameters

    Returns this

removeUnionExt

  • removeUnionExt(typename: Typename): this
  • Parameters

    Returns this

removeUnionType

  • removeUnionType(typename: Typename): this
  • Parameters

    Returns this

toDocument

  • toDocument(): DocumentNode
  • serialise to DocumentNode

    Returns DocumentNode

toJson

  • toJson(options?: GQL.BuildSchemaOptions): ExecutionResult
  • serialise to graphql introspection query result

    Parameters

    • Optional options: GQL.BuildSchemaOptions

    Returns ExecutionResult

toSchema

  • toSchema(options?: GQL.BuildSchemaOptions): GraphQLSchema
  • serialise to GraphQLSchema

    Parameters

    • Optional options: GQL.BuildSchemaOptions

    Returns GraphQLSchema

toString

  • toString(): string
  • serialise to string

    Returns string

updateDirective

  • updateDirective(directivename: Directivename, props: DirectiveDefinitionNode | Ast.DirectiveDefinitionNodeProps): this
  • Parameters

    • directivename: Directivename
    • props: DirectiveDefinitionNode | Ast.DirectiveDefinitionNodeProps

    Returns this

updateEnumExt

  • updateEnumExt(typename: Typename, props: Ast.EnumTypeDefinitionNodeProps | EnumTypeDefinitionNode): this
  • Parameters

    • typename: Typename
    • props: Ast.EnumTypeDefinitionNodeProps | EnumTypeDefinitionNode

    Returns this

updateEnumType

  • updateEnumType(typename: Typename, props: Ast.EnumTypeDefinitionNodeProps | EnumTypeDefinitionNode): this
  • Parameters

    • typename: Typename
    • props: Ast.EnumTypeDefinitionNodeProps | EnumTypeDefinitionNode

    Returns this

updateExt

  • updateExt(typename: Typename, props: Ast.TypeExtensionNodeProps): this
  • Parameters

    • typename: Typename
    • props: Ast.TypeExtensionNodeProps

    Returns this

updateFragment

  • updateFragment(fragmentname: Fragmentname, props: Ast.FragmentDefinitionNodeProps | FragmentDefinitionNode): this
  • Parameters

    • fragmentname: Fragmentname
    • props: Ast.FragmentDefinitionNodeProps | FragmentDefinitionNode

    Returns this

updateInputExt

  • updateInputExt(typename: Typename, props: Ast.InputObjectTypeDefinitionNodeProps | InputObjectTypeDefinitionNode): this
  • Parameters

    • typename: Typename
    • props: Ast.InputObjectTypeDefinitionNodeProps | InputObjectTypeDefinitionNode

    Returns this

updateInputType

  • updateInputType(typename: Typename, props: Ast.InputObjectTypeDefinitionNodeProps | InputObjectTypeDefinitionNode): this
  • Parameters

    • typename: Typename
    • props: Ast.InputObjectTypeDefinitionNodeProps | InputObjectTypeDefinitionNode

    Returns this

updateInterfaceExt

  • updateInterfaceExt(typename: Typename, props: Ast.InterfaceTypeDefinitionNodeProps | InterfaceTypeDefinitionNode): this
  • Parameters

    • typename: Typename
    • props: Ast.InterfaceTypeDefinitionNodeProps | InterfaceTypeDefinitionNode

    Returns this

updateInterfaceType

  • updateInterfaceType(typename: Typename, props: Ast.InterfaceTypeDefinitionNodeProps | InterfaceTypeDefinitionNode): this
  • Parameters

    • typename: Typename
    • props: Ast.InterfaceTypeDefinitionNodeProps | InterfaceTypeDefinitionNode

    Returns this

updateObjectExt

  • updateObjectExt(typename: Typename, props: Ast.ObjectTypeDefinitionNodeProps | ObjectTypeDefinitionNode): this
  • Parameters

    • typename: Typename
    • props: Ast.ObjectTypeDefinitionNodeProps | ObjectTypeDefinitionNode

    Returns this

updateObjectType

  • updateObjectType(typename: Typename, props: Ast.ObjectTypeDefinitionNodeProps | ObjectTypeDefinitionNode): this
  • Parameters

    • typename: Typename
    • props: Ast.ObjectTypeDefinitionNodeProps | ObjectTypeDefinitionNode

    Returns this

updateOperation

  • updateOperation(operationname: string | undefined, props: Ast.OperationDefinitionNodeProps | OperationDefinitionNode): this
  • Parameters

    • operationname: string | undefined
    • props: Ast.OperationDefinitionNodeProps | OperationDefinitionNode

    Returns this

updateScalarExt

  • updateScalarExt(typename: Typename, props: Ast.ScalarTypeDefinitionNodeProps | ScalarTypeDefinitionNode): this
  • Parameters

    • typename: Typename
    • props: Ast.ScalarTypeDefinitionNodeProps | ScalarTypeDefinitionNode

    Returns this

updateScalarType

  • updateScalarType(typename: Typename, props: Ast.ScalarTypeDefinitionNodeProps | ScalarTypeDefinitionNode): this
  • Parameters

    • typename: Typename
    • props: Ast.ScalarTypeDefinitionNodeProps | ScalarTypeDefinitionNode

    Returns this

updateSchemaDefinition

  • updateSchemaDefinition(props: Partial<Ast.SchemaDefinitionNodeProps>): this
  • Parameters

    • props: Partial<Ast.SchemaDefinitionNodeProps>

    Returns this

updateSchemaExtension

  • updateSchemaExtension(props: Partial<Ast.SchemaExtensionNodeProps>): this
  • Parameters

    • props: Partial<Ast.SchemaExtensionNodeProps>

    Returns this

updateType

  • updateType(typename: Typename, props: Ast.TypeDefinitionNodeProps): this
  • Parameters

    • typename: Typename
    • props: Ast.TypeDefinitionNodeProps

    Returns this

updateUnionExt

  • updateUnionExt(typename: Typename, props: Ast.UnionTypeDefinitionNodeProps | UnionTypeDefinitionNode): this
  • Parameters

    • typename: Typename
    • props: Ast.UnionTypeDefinitionNodeProps | UnionTypeDefinitionNode

    Returns this

updateUnionType

  • updateUnionType(typename: Typename, props: Ast.UnionTypeDefinitionNodeProps | UnionTypeDefinitionNode): this
  • Parameters

    • typename: Typename
    • props: Ast.UnionTypeDefinitionNodeProps | UnionTypeDefinitionNode

    Returns this

upsertDirective

  • upsertDirective(props: DirectiveDefinitionNode | Ast.DirectiveDefinitionNodeProps): this
  • Parameters

    • props: DirectiveDefinitionNode | Ast.DirectiveDefinitionNodeProps

    Returns this

upsertEnumExt

  • upsertEnumExt(props: Ast.EnumTypeDefinitionNodeProps | EnumTypeDefinitionNode): this
  • Parameters

    • props: Ast.EnumTypeDefinitionNodeProps | EnumTypeDefinitionNode

    Returns this

upsertEnumType

  • upsertEnumType(props: Ast.EnumTypeDefinitionNodeProps | EnumTypeDefinitionNode): this
  • Parameters

    • props: Ast.EnumTypeDefinitionNodeProps | EnumTypeDefinitionNode

    Returns this

upsertExt

  • upsertExt(props: Ast.TypeExtensionNodeProps): this
  • Parameters

    • props: Ast.TypeExtensionNodeProps

    Returns this

upsertFragment

  • upsertFragment(props: Ast.FragmentDefinitionNodeProps | FragmentDefinitionNode): this
  • Parameters

    • props: Ast.FragmentDefinitionNodeProps | FragmentDefinitionNode

    Returns this

upsertInputExt

  • upsertInputExt(props: Ast.InputObjectTypeDefinitionNodeProps | InputObjectTypeDefinitionNode): this
  • Parameters

    • props: Ast.InputObjectTypeDefinitionNodeProps | InputObjectTypeDefinitionNode

    Returns this

upsertInputType

  • upsertInputType(props: Ast.InputObjectTypeDefinitionNodeProps | InputObjectTypeDefinitionNode): this
  • Parameters

    • props: Ast.InputObjectTypeDefinitionNodeProps | InputObjectTypeDefinitionNode

    Returns this

upsertInterfaceExt

  • upsertInterfaceExt(props: Ast.InterfaceTypeDefinitionNodeProps | InterfaceTypeDefinitionNode): this
  • Parameters

    • props: Ast.InterfaceTypeDefinitionNodeProps | InterfaceTypeDefinitionNode

    Returns this

upsertInterfaceType

  • upsertInterfaceType(props: Ast.InterfaceTypeDefinitionNodeProps | InterfaceTypeDefinitionNode): this
  • Parameters

    • props: Ast.InterfaceTypeDefinitionNodeProps | InterfaceTypeDefinitionNode

    Returns this

upsertObjectExt

  • upsertObjectExt(props: Ast.ObjectTypeDefinitionNodeProps | ObjectTypeDefinitionNode): this
  • Parameters

    • props: Ast.ObjectTypeDefinitionNodeProps | ObjectTypeDefinitionNode

    Returns this

upsertObjectType

  • upsertObjectType(props: Ast.ObjectTypeDefinitionNodeProps | ObjectTypeDefinitionNode): this
  • Parameters

    • props: Ast.ObjectTypeDefinitionNodeProps | ObjectTypeDefinitionNode

    Returns this

upsertOperation

  • upsertOperation(props: Ast.OperationDefinitionNodeProps | OperationDefinitionNode): this
  • Parameters

    • props: Ast.OperationDefinitionNodeProps | OperationDefinitionNode

    Returns this

upsertScalarExt

  • upsertScalarExt(props: Ast.ScalarTypeDefinitionNodeProps | ScalarTypeDefinitionNode): this
  • Parameters

    • props: Ast.ScalarTypeDefinitionNodeProps | ScalarTypeDefinitionNode

    Returns this

upsertScalarType

  • upsertScalarType(props: Ast.ScalarTypeDefinitionNodeProps | ScalarTypeDefinitionNode): this
  • Parameters

    • props: Ast.ScalarTypeDefinitionNodeProps | ScalarTypeDefinitionNode

    Returns this

upsertSchemaDefinition

  • upsertSchemaDefinition(props: Ast.SchemaDefinitionNodeProps): this
  • Parameters

    • props: Ast.SchemaDefinitionNodeProps

    Returns this

upsertSchemaExtension

  • upsertSchemaExtension(props: Ast.SchemaExtensionNodeProps): this
  • Parameters

    • props: Ast.SchemaExtensionNodeProps

    Returns this

upsertType

  • upsertType(props: Ast.TypeDefinitionNodeProps): this
  • Parameters

    • props: Ast.TypeDefinitionNodeProps

    Returns this

upsertUnionExt

  • upsertUnionExt(props: Ast.UnionTypeDefinitionNodeProps | UnionTypeDefinitionNode): this
  • Parameters

    • props: Ast.UnionTypeDefinitionNodeProps | UnionTypeDefinitionNode

    Returns this

upsertUnionType

  • upsertUnionType(props: Ast.UnionTypeDefinitionNodeProps | UnionTypeDefinitionNode): this
  • Parameters

    • props: Ast.UnionTypeDefinitionNodeProps | UnionTypeDefinitionNode

    Returns this

Generated using TypeDoc