import type { Maybe } from '../jsutils/Maybe'; import type { DirectiveDefinitionNode } from '../language/ast'; import { DirectiveLocation } from '../language/directiveLocation'; import type { GraphQLArgument, GraphQLFieldConfigArgumentMap, } from './definition'; /** * Test if the given value is a GraphQL directive. */ export declare function isDirective( directive: unknown, ): directive is GraphQLDirective; export declare function assertDirective(directive: unknown): GraphQLDirective; /** * 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. */ export interface GraphQLDirectiveExtensions { [attributeName: string]: unknown; } /** * Directives are used by the GraphQL runtime as a way of modifying execution * behavior. Type system creators will usually not create these directly. */ export declare class GraphQLDirective { name: string; description: Maybe; locations: ReadonlyArray; args: ReadonlyArray; isRepeatable: boolean; extensions: Readonly; astNode: Maybe; constructor(config: Readonly); get [Symbol.toStringTag](): string; toConfig(): GraphQLDirectiveNormalizedConfig; toString(): string; toJSON(): string; } export interface GraphQLDirectiveConfig { name: string; description?: Maybe; locations: ReadonlyArray; args?: Maybe; isRepeatable?: Maybe; extensions?: Maybe>; astNode?: Maybe; } interface GraphQLDirectiveNormalizedConfig extends GraphQLDirectiveConfig { args: GraphQLFieldConfigArgumentMap; isRepeatable: boolean; extensions: Readonly; } /** * Used to conditionally include fields or fragments. */ export declare const GraphQLIncludeDirective: GraphQLDirective; /** * Used to conditionally skip (exclude) fields or fragments. */ export declare const GraphQLSkipDirective: GraphQLDirective; /** * Constant string used for default reason for a deprecation. */ export declare const DEFAULT_DEPRECATION_REASON = 'No longer supported'; /** * Used to declare element of a GraphQL schema as deprecated. */ export declare const GraphQLDeprecatedDirective: GraphQLDirective; /** * Used to provide a URL for specifying the behavior of custom scalar definitions. */ export declare const GraphQLSpecifiedByDirective: GraphQLDirective; /** * The full list of specified directives. */ export declare const specifiedDirectives: ReadonlyArray; export declare function isSpecifiedDirective( directive: GraphQLDirective, ): boolean; export {};