Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TypeApi

API for GraphQL TypeNode

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new TypeApi(node: GQL.TypeNode): TypeApi

Properties

Readonly node

node: GQL.TypeNode

Methods

Private _getNamedType

  • _getNamedType(type: GQL.TypeNode): NamedTypeNode

  • Parameters

    • type: GQL.TypeNode

    Returns NamedTypeNode

Private _isListDeep

  • _isListDeep(type: GQL.TypeNode): boolean

  • Parameters

    • type: GQL.TypeNode

    Returns boolean

Private _isNonNullDeep

  • _isNonNullDeep(type: GQL.TypeNode): boolean

  • Parameters

    • type: GQL.TypeNode

    Returns boolean

assertKind

getNamedType

  • getNamedType(): NamedTypeNode

  • Returns NamedTypeNode

getTypename

  • Returns Typename

isKind

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

  • Type parameters

    • K: GQL.KindEnum

    Parameters

    • kind: K

    Returns this is KindToApiType<K>

isList

  • isList(deep?: boolean): boolean

  • Parameters

    • Default value deep: boolean = true

    Returns boolean

isNonNull

  • isNonNull(deep?: boolean): boolean

  • Parameters

    • Default value deep: boolean = true

    Returns boolean

setList

  • setList(value?: boolean): this

  • Parameters

    • Default value value: boolean = true

    Returns this

setNonNull

  • setNonNull(value?: boolean): this

  • Parameters

    • Default value value: boolean = true

    Returns this

setType

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

  • Parameters

    • props: Ast.TypeNodeProps | GQL.TypeNode

    Returns this

setTypename

  • Parameters

    Returns this

Generated using TypeDoc