DirectiveDefinitionApi | graphql-extra

Hierarchy

NameMixin<this> & KindAssertionMixin<this> & DescriptionMixin<this> & InputValuesAsArgumentsMixin<this>
- DirectiveDefinitionApi

Index

Constructors

constructor

new DirectiveDefinitionApi(node: DirectiveDefinitionNode): DirectiveDefinitionApi

Overrides NameMixin.constructor
- Defined in src/api/directive-definition.ts:21
Parameters
- node: DirectiveDefinitionNode
Returns DirectiveDefinitionApi

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 _locations

_locations: Crud<NameNode, "VARIABLE_DEFINITION" | "FIELD" | "FRAGMENT_SPREAD" | "INLINE_FRAGMENT" | "FRAGMENT_DEFINITION" | "ENUM" | "OBJECT" | "FIELD_DEFINITION" | "QUERY" | "MUTATION" | "SUBSCRIPTION" | "SCHEMA" | "SCALAR" | "ARGUMENT_DEFINITION" | "INTERFACE" | "UNION" | "ENUM_VALUE" | "INPUT_OBJECT" | "INPUT_FIELD_DEFINITION", string | { name: string }, "VARIABLE_DEFINITION" | "FIELD" | "FRAGMENT_SPREAD" | "INLINE_FRAGMENT" | "FRAGMENT_DEFINITION" | "ENUM" | "OBJECT" | "FIELD_DEFINITION" | "QUERY" | "MUTATION" | "SUBSCRIPTION" | "SCHEMA" | "SCALAR" | "ARGUMENT_DEFINITION" | "INTERFACE" | "UNION" | "ENUM_VALUE" | "INPUT_OBJECT" | "INPUT_FIELD_DEFINITION"> = new Crud({api: (node): GQL.DirectiveLocationEnum => node.value as GQL.DirectiveLocationEnum,factory: Ast.nameNode,key: 'locations',matcher: (node): GQL.DirectiveLocationEnum => node.value as GQL.DirectiveLocationEnum,parent: this.node,})

Readonly node

node: DirectiveDefinitionNode

Methods

assertKind

assertKind<K>(kind: K): KindToApiType<K>

Inherited from KindAssertionMixin.assertKind
- Defined in src/mixin/kind-assertion.ts:16
Type parameters
- K: GQL.KindEnum
Parameters
- kind: K
Returns KindToApiType<K>

createArgument

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

Inherited from InputValuesAsArgumentsMixin.createArgument
- Defined in src/mixin/input-values-as-arguments.ts:52
Parameters
- props: InputValueDefinitionNode | Ast.InputValueDefinitionNodeProps
Returns this

createLocation

createLocation(location: NameNode | GQL.DirectiveLocationEnum): this

- Defined in src/api/directive-definition.ts:65
Parameters
- location: NameNode | GQL.DirectiveLocationEnum
Returns this

getArgnames

getArgnames(): Argname[]

Inherited from InputValuesAsArgumentsMixin.getArgnames
- Defined in src/mixin/input-values-as-arguments.ts:32
Returns Argname[]

getArgument

getArgument(argname: Argname): InputValueDefinitionApi

Inherited from InputValuesAsArgumentsMixin.getArgument
- Defined in src/mixin/input-values-as-arguments.ts:48
Parameters
- argname: Argname
Returns InputValueDefinitionApi

getArgumentDefaultValue

getArgumentDefaultValue(argname: Argname): ValueApi | undefined

Inherited from InputValuesAsArgumentsMixin.getArgumentDefaultValue
- Defined in src/mixin/input-values-as-arguments.ts:91
Parameters
- argname: Argname
Returns ValueApi | undefined

getArgumentType

getArgumentType(argname: Argname): TypeApi

Inherited from InputValuesAsArgumentsMixin.getArgumentType
- Defined in src/mixin/input-values-as-arguments.ts:79
Parameters
- argname: Argname
Returns TypeApi

getArguments

getArguments(): InputValueDefinitionApi[]

Inherited from InputValuesAsArgumentsMixin.getArguments
- Defined in src/mixin/input-values-as-arguments.ts:36
Returns InputValueDefinitionApi[]

getArgumentsByTypename

getArgumentsByTypename(typename: Typename): InputValueDefinitionApi[]

Inherited from InputValuesAsArgumentsMixin.getArgumentsByTypename
- Defined in src/mixin/input-values-as-arguments.ts:40
Parameters
- typename: Typename
Returns InputValueDefinitionApi[]

getDescription

getDescription(): string | undefined

Inherited from DescriptionMixin.getDescription
- Defined in src/mixin/description.ts:32
Returns string | undefined

getLocations

getLocations(): GQL.DirectiveLocationEnum[]

- Defined in src/api/directive-definition.ts:55
Returns GQL.DirectiveLocationEnum[]

getName

getName(): string

Inherited from NameMixin.getName
- Defined in src/mixin/name.ts:29
Returns string

hasArgument

hasArgument(argname: Argname): boolean

Inherited from InputValuesAsArgumentsMixin.hasArgument
- Defined in src/mixin/input-values-as-arguments.ts:44
Parameters
- argname: Argname
Returns boolean

hasDescription

hasDescription(value?: undefined | string): boolean

Inherited from DescriptionMixin.hasDescription
- Defined in src/mixin/description.ts:24
Parameters
- Optional value: undefined | string
Returns boolean

hasLocation

hasLocation(location: NameNode | GQL.DirectiveLocationEnum): boolean

- Defined in src/api/directive-definition.ts:51
Parameters
- location: NameNode | GQL.DirectiveLocationEnum
Returns boolean

isKind

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

Inherited from KindAssertionMixin.isKind
- Defined in src/mixin/kind-assertion.ts:12
Type parameters
- K: GQL.KindEnum
Parameters
- kind: K
Returns this is KindToApiType<K>

isRepeatable

isRepeatable(): boolean

- Defined in src/api/directive-definition.ts:39
Returns boolean

removeArgument

removeArgument(argname: Argname): this

Inherited from InputValuesAsArgumentsMixin.removeArgument
- Defined in src/mixin/input-values-as-arguments.ts:73
Parameters
- argname: Argname
Returns this

removeLocation

removeLocation(location: NameNode | GQL.DirectiveLocationEnum): this

- Defined in src/api/directive-definition.ts:71
Parameters
- location: NameNode | GQL.DirectiveLocationEnum
Returns this

setArgumentDefualtValue

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

Inherited from InputValuesAsArgumentsMixin.setArgumentDefualtValue
- Defined in src/mixin/input-values-as-arguments.ts:95
Parameters
- argname: Argname
- props: GQL.ValueNode
Returns this

setArgumentType

setArgumentType(argname: Argname, props: GQL.TypeNode | Ast.TypeNodeProps): this

Inherited from InputValuesAsArgumentsMixin.setArgumentType
- Defined in src/mixin/input-values-as-arguments.ts:83
Parameters
- argname: Argname
- props: GQL.TypeNode | Ast.TypeNodeProps
Returns this

setDescription

setDescription(value: string | undefined): this

Inherited from DescriptionMixin.setDescription
- Defined in src/mixin/description.ts:36
Parameters
- value: string | undefined
Returns this

setLocations

setLocations(locations: ("VARIABLE_DEFINITION" | "FIELD" | "FRAGMENT_SPREAD" | "INLINE_FRAGMENT" | "FRAGMENT_DEFINITION" | "ENUM" | "OBJECT" | "FIELD_DEFINITION" | NameNode | "QUERY" | "MUTATION" | "SUBSCRIPTION" | "SCHEMA" | "SCALAR" | "ARGUMENT_DEFINITION" | "INTERFACE" | "UNION" | "ENUM_VALUE" | "INPUT_OBJECT" | "INPUT_FIELD_DEFINITION")[]): this

- Defined in src/api/directive-definition.ts:59
Parameters
- locations: ("VARIABLE_DEFINITION" | "FIELD" | "FRAGMENT_SPREAD" | "INLINE_FRAGMENT" | "FRAGMENT_DEFINITION" | "ENUM" | "OBJECT" | "FIELD_DEFINITION" | NameNode | "QUERY" | "MUTATION" | "SUBSCRIPTION" | "SCHEMA" | "SCALAR" | "ARGUMENT_DEFINITION" | "INTERFACE" | "UNION" | "ENUM_VALUE" | "INPUT_OBJECT" | "INPUT_FIELD_DEFINITION")[]
Returns this

setName

setName(value: string): this

Inherited from NameMixin.setName
- Defined in src/mixin/name.ts:33
Parameters
- value: string
Returns this

setRepeatable

setRepeatable(value?: boolean): this

- Defined in src/api/directive-definition.ts:43
Parameters
- Default value value: boolean = true
Returns this

updateArgument

updateArgument(argname: Argname, props: Partial<InputValueDefinitionNode | Ast.InputValueDefinitionNodeProps>): this

Inherited from InputValuesAsArgumentsMixin.updateArgument
- Defined in src/mixin/input-values-as-arguments.ts:64
Parameters
- argname: Argname
- props: Partial<InputValueDefinitionNode | Ast.InputValueDefinitionNodeProps>
Returns this

upsertArgument

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

Inherited from InputValuesAsArgumentsMixin.upsertArgument
- Defined in src/mixin/input-values-as-arguments.ts:58
Parameters
- props: InputValueDefinitionNode | Ast.InputValueDefinitionNodeProps
Returns this

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

node: DirectiveDefinitionNode

Returns DirectiveDefinitionApi

Properties

Readonly _arguments

Readonly _locations

Readonly node

Methods

assertKind

Type parameters

K: GQL.KindEnum

Parameters

kind: K

Returns KindToApiType<K>

createArgument

Parameters

props: InputValueDefinitionNode | Ast.InputValueDefinitionNodeProps

Returns this

createLocation

Parameters

location: NameNode | GQL.DirectiveLocationEnum

Returns this

getArgnames

Returns Argname[]

getArgument

Parameters

argname: Argname

Returns InputValueDefinitionApi

getArgumentDefaultValue

Parameters

argname: Argname

Returns ValueApi | undefined

getArgumentType

Parameters

argname: Argname

Returns TypeApi

getArguments

Returns InputValueDefinitionApi[]

getArgumentsByTypename

Parameters

typename: Typename

Returns InputValueDefinitionApi[]

getDescription

Returns string | undefined

getLocations

Returns GQL.DirectiveLocationEnum[]

getName

Returns string

hasArgument

Parameters

argname: Argname

Returns boolean

hasDescription

Parameters

Optional value: undefined | string

Returns boolean

hasLocation

Parameters

location: NameNode | GQL.DirectiveLocationEnum

Returns boolean

isKind

Type parameters

K: GQL.KindEnum

Parameters

kind: K

Returns this is KindToApiType<K>

isRepeatable

Returns boolean

removeArgument

Parameters

argname: Argname

Returns this

removeLocation