Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DocumentBaseApi

Hierarchy

Index

Constructors

constructor

  • Parameters

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

    Returns DocumentBaseApi

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>
  • Returns 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

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

Generated using TypeDoc