graphql/type/directives

Classes

GraphQLDirective

Directives are used by the GraphQL runtime as a way of modifying execution behavior. Type system creators will usually not create these directly.

Constructor

Creates a GraphQLDirective instance.

Signature:

new GraphQLDirective(config: Readonly<GraphQLDirectiveConfig>)

Arguments

Returns

Members

toConfig()

Returns a normalized configuration object for this object.

Signature:

toConfig(): { args: GraphQLFieldConfigArgumentMap; isRepeatable: boolean; extensions: Readonly<GraphQLDirectiveExtensions>; extensionASTNodes: ReadonlyArray<DirectiveExtensionNode> }

Returns

Example

// Given a GraphQLDirective instance named directive:
const result = directive.toConfig();
 
// result contains the toConfig return value

toString()

Returns the schema coordinate identifying this directive.

Signature:

toString(): string

Returns

Example

const coordinate = directive.toString();
 
// coordinate: a directive schema coordinate, for example '@include'

toJSON()

Returns the JSON representation used when this object is serialized.

Signature:

toJSON(): string

Returns

Example

const json = directive.toJSON();
 
// json: the JSON representation

Functions

isDirective()

Test if the given value is a GraphQL directive.

Signature:

isDirective(directive: unknown): directive is GraphQLDirective

Arguments

Returns

Example

import { isDirective, GraphQLString } from 'graphql/type';
 
const result = isDirective(GraphQLString);
 
// result: true for matching GraphQL types

assertDirective()

Returns the value as a GraphQLDirective, or throws if it is not a directive.

Signature:

assertDirective(directive: unknown): GraphQLDirective

Arguments

Returns

Example

import { assertDirective, GraphQLString } from 'graphql/type';
 
const type = assertDirective(GraphQLString);
 
// type: GraphQLString

isSpecifiedDirective()

Returns true when the directive is one of the directives specified by GraphQL.

Signature:

isSpecifiedDirective(directive: GraphQLDirective): boolean

Arguments

Returns

Example

import { isSpecifiedDirective, GraphQLString } from 'graphql/type';
 
const result = isSpecifiedDirective(GraphQLString);
 
// result: true for matching GraphQL types

Constants

GraphQLIncludeDirective

Used to conditionally include fields or fragments.

GraphQLSkipDirective

Used to conditionally skip (exclude) fields or fragments.

DEFAULT_DEPRECATION_REASON

Constant string used for default reason for a deprecation.

GraphQLDeprecatedDirective

Used to declare element of a GraphQL schema as deprecated.

GraphQLSpecifiedByDirective

Used to provide a URL for specifying the behavior of custom scalar definitions.

GraphQLOneOfDirective

Used to indicate an Input Object is a OneOf Input Object.

specifiedDirectives

The full list of specified directives.

Types

GraphQLDirectiveExtensions

Interface. Custom extensions

Remarks: Use a unique identifier name for your extension, for example the name of your library or project. Do not use a shortened identifier as this increases the risk of conflicts. We recommend you add at most one extension field, an object which can contain all the values you need.

GraphQLDirectiveConfig

Interface. Configuration used to construct a GraphQLDirective.

Members