Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EnumTypeApi

API for GraphQL EnumTypeDefinitionNode

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new EnumTypeApi(node: EnumTypeDefinitionNode): EnumTypeApi

Properties

Readonly _directives

_directives: Crud<DirectiveNode, DirectiveApi, string | { arguments?: ReadonlyArray<ArgumentNode | ArgumentNodeProps>; name: NameNodeProps | NameNode }, string> = new Crud({parent: this.node,key: 'directives',api: Api.directiveApi,factory: Ast.directiveNode,matcher: (node): Directivename => node.name.value,})

Readonly _values

_values: Crud<EnumValueDefinitionNode, EnumValueDefinitionApi, string | { description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode }, string> = new Crud({parent: this.node,key: 'values',api: Api.enumValueDefinitionApi,factory: Ast.enumValueDefinitionNode,matcher: (node): Fieldname => node.name.value,})

Readonly node

node: EnumTypeDefinitionNode

Methods

assertEnumType

assertInputType

assertInterfaceType

assertKind

assertObjectType

assertScalarType

assertUnionType

createDirective

  • createDirective(props: Ast.DirectiveNodeProps | DirectiveNode): this

  • Parameters

    • props: Ast.DirectiveNodeProps | DirectiveNode

    Returns this

createValue

  • createValue(props: Ast.EnumValueDefinitionNodeProps | EnumValueDefinitionNode): this

  • Parameters

    • props: Ast.EnumValueDefinitionNodeProps | EnumValueDefinitionNode

    Returns this

getDescription

  • getDescription(): string | undefined

getDirective

getDirectiveNames

getDirectives

getName

  • getName(): string

  • Returns string

getValue

getValueNames

getValues

hasDescription

  • hasDescription(value?: undefined | string): boolean

hasDirective

hasValue

isEnumType

  • isEnumType(): this is EnumTypeApi

isInputType

  • isInputType(): this is InputTypeApi

isInterfaceType

  • isInterfaceType(): this is InterfaceTypeApi

isKind

  • isKind<K>(kind: K): this is KindToApiType<K>

  • Type parameters

    • K: GQL.KindEnum

    Parameters

    • kind: K

    Returns this is KindToApiType<K>

isObjectType

  • isObjectType(): this is ObjectTypeApi

isScalarType

  • isScalarType(): this is ScalarTypeApi

isUnionType

  • isUnionType(): this is UnionTypeApi

removeDirective

removeValue

setDescription

  • setDescription(value: string | undefined): this

setName

  • setName(value: string): this

  • Parameters

    • value: string

    Returns this

updateDirective

  • updateDirective(directivename: Directivename, props: Ast.DirectiveNodeProps | Partial<Ast.DirectiveNodeProps | DirectiveNode>): this

  • Parameters

    • directivename: Directivename
    • props: Ast.DirectiveNodeProps | Partial<Ast.DirectiveNodeProps | DirectiveNode>

    Returns this

updateValue

  • updateValue(fieldname: Fieldname, props: Fieldname | Partial<Ast.EnumValueDefinitionNodeProps | EnumValueDefinitionNode>): this

upsertDirective

  • upsertDirective(props: Ast.DirectiveNodeProps | DirectiveNode): this

  • Parameters

    • props: Ast.DirectiveNodeProps | DirectiveNode

    Returns this

upsertValue

  • upsertValue(props: Ast.EnumValueDefinitionNodeProps | EnumValueDefinitionNode): this

  • Parameters

    • props: Ast.EnumValueDefinitionNodeProps | EnumValueDefinitionNode

    Returns this

Generated using TypeDoc