Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InputValueDefinitionApi

API for GraphQL InputValueDefinitionNode

Hierarchy

Index

Constructors

constructor

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 node

node: InputValueDefinitionNode

Methods

assertKind

createDirective

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

    • props: Ast.DirectiveNodeProps | DirectiveNode

    Returns this

getDefaultValue

  • getDefaultValue(): ValueApi | undefined

getDescription

  • getDescription(): string | undefined

getDirective

getDirectiveNames

getDirectives

getName

  • getName(): string
  • Returns string

getNamedType

  • getNamedType(): NamedTypeNode

getType

getTypename

hasDefaultValue

  • hasDefaultValue(): boolean

hasDescription

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

hasDirective

isKind

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

    • K: GQL.KindEnum

    Parameters

    • kind: K

    Returns this is KindToApiType<K>

isListType

  • isListType(deep?: undefined | false | true): boolean
  • Parameters

    • Optional deep: undefined | false | true

    Returns boolean

isNonNullType

  • isNonNullType(deep?: undefined | false | true): boolean
  • Parameters

    • Optional deep: undefined | false | true

    Returns boolean

removeDirective

setDefaultValue

  • setDefaultValue(props: undefined | Ast.ValueNodeProps | GQL.ValueNode): this
  • Parameters

    • props: undefined | Ast.ValueNodeProps | GQL.ValueNode

    Returns this

setDescription

  • setDescription(value: string | undefined): this

setListType

  • setListType(to?: boolean): this
  • Parameters

    • Default value to: boolean = true

    Returns this

setName

  • setName(value: string): this
  • Parameters

    • value: string

    Returns this

setNonNullType

  • setNonNullType(to?: boolean): this
  • Parameters

    • Default value to: boolean = true

    Returns this

setType

  • setType(props: Ast.TypeNodeProps | GQL.TypeNode): this
  • Parameters

    • props: Ast.TypeNodeProps | GQL.TypeNode

    Returns this

setTypename

toField

updateDirective

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

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

    Returns this

upsertDirective

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

    • props: Ast.DirectiveNodeProps | DirectiveNode

    Returns this

Generated using TypeDoc