Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FieldDefinitionApi

API for GraphQL FieldDefinitionNode

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly _arguments

_arguments: Crud<InputValueDefinitionNode, InputValueDefinitionApi, { defaultValue?: GQL.ValueNode; description?: StringValueNodeProps | StringValueNode; directives?: ReadonlyArray<DirectiveNodeProps | DirectiveNode>; name: NameNodeProps | NameNode; type: TypeNodeProps | GQL.TypeNode }, string> = new Crud({parent: this.node,key: 'arguments',api: Api.inputValueDefinitionApi,factory: Ast.inputValueDefinitionNode,matcher: (node): Argname => node.name.value,})

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: FieldDefinitionNode

Methods

assertKind

createArgument

  • createArgument(props: InputValueDefinitionNode | Ast.InputValueDefinitionNodeProps): this

createDirective

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

  • Parameters

    • props: Ast.DirectiveNodeProps | DirectiveNode

    Returns this

getArgnames

getArgument

getArgumentDefaultValue

getArgumentType

getArguments

getArgumentsByTypename

getDescription

  • getDescription(): string | undefined

getDirective

getDirectiveNames

getDirectives

getName

  • getName(): string

  • Returns string

getNamedType

  • getNamedType(): NamedTypeNode

getType

getTypename

hasArgument

  • hasArgument(argname: Argname): 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

removeArgument

  • removeArgument(argname: Argname): this

removeDirective

setArgumentDefualtValue

  • setArgumentDefualtValue(argname: Argname, props: GQL.ValueNode): this

setArgumentType

  • setArgumentType(argname: Argname, props: GQL.TypeNode | Ast.TypeNodeProps): 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

toInputValue

updateArgument

  • updateArgument(argname: Argname, props: Partial<InputValueDefinitionNode | Ast.InputValueDefinitionNodeProps>): 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

upsertArgument

  • upsertArgument(props: InputValueDefinitionNode | Ast.InputValueDefinitionNodeProps): this

upsertDirective

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

  • Parameters

    • props: Ast.DirectiveNodeProps | DirectiveNode

    Returns this

Generated using TypeDoc