Skip to main content
Module

x/graphql_deno/lib/type/directives.d.ts

GraphQL-JS ported to Deno
Latest
File
// FIXME/* eslint-disable import/no-cycle */
import Maybe from '../tsutils/Maybe.d.ts';
import { DirectiveDefinitionNode } from '../language/ast.d.ts';import { DirectiveLocationEnum } from '../language/directiveLocation.d.ts';
import { GraphQLFieldConfigArgumentMap, GraphQLArgument } from './definition.d.ts';
/** * Test if the given value is a GraphQL directive. */export function isDirective(directive: any): directive is GraphQLDirective;export function assertDirective(directive: any): GraphQLDirective;/** * Directives are used by the GraphQL runtime as a way of modifying execution * behavior. Type system creators will usually not create these directly. */export class GraphQLDirective { name: string; description: Maybe<string>; locations: Array<DirectiveLocationEnum>; isRepeatable: boolean; args: Array<GraphQLArgument>; extensions: Maybe<Readonly<Record<string, any>>>; astNode: Maybe<DirectiveDefinitionNode>;
constructor(config: Readonly<GraphQLDirectiveConfig>);
toConfig(): GraphQLDirectiveConfig & { args: GraphQLFieldConfigArgumentMap; isRepeatable: boolean; extensions: Maybe<Readonly<Record<string, any>>>; };
toString(): string; toJSON(): string; inspect(): string;}
export interface GraphQLDirectiveConfig { name: string; description?: Maybe<string>; locations: Array<DirectiveLocationEnum>; args?: Maybe<GraphQLFieldConfigArgumentMap>; isRepeatable?: Maybe<boolean>; extensions?: Maybe<Readonly<Record<string, any>>>; astNode?: Maybe<DirectiveDefinitionNode>;}
/** * Used to conditionally include fields or fragments. */export const GraphQLIncludeDirective: GraphQLDirective;
/** * Used to conditionally skip (exclude) fields or fragments. */export const GraphQLSkipDirective: GraphQLDirective;
/** * Constant string used for default reason for a deprecation. */export const DEFAULT_DEPRECATION_REASON: 'No longer supported';
/** * Used to declare element of a GraphQL schema as deprecated. */export const GraphQLDeprecatedDirective: GraphQLDirective;
/** * The full list of specified directives. */export const specifiedDirectives: ReadonlyArray<GraphQLDirective>;
export function isSpecifiedDirective(directive: GraphQLDirective): boolean;