1 |
|
2 |
|
3 |
|
4 | import { Maybe } from '../jsutils/Maybe';
|
5 |
|
6 | import { SchemaDefinitionNode, SchemaExtensionNode } from '../language/ast';
|
7 |
|
8 | import { GraphQLDirective } from './directives';
|
9 | import {
|
10 | GraphQLNamedType,
|
11 | GraphQLAbstractType,
|
12 | GraphQLObjectType,
|
13 | GraphQLInterfaceType,
|
14 | } from './definition';
|
15 |
|
16 |
|
17 |
|
18 |
|
19 | export function isSchema(schema: any): schema is GraphQLSchema;
|
20 | export function assertSchema(schema: any): GraphQLSchema;
|
21 |
|
22 |
|
23 |
|
24 |
|
25 |
|
26 |
|
27 |
|
28 |
|
29 |
|
30 |
|
31 | export interface GraphQLSchemaExtensions {
|
32 | [attributeName: string]: any;
|
33 | }
|
34 |
|
35 |
|
36 |
|
37 |
|
38 |
|
39 |
|
40 |
|
41 |
|
42 |
|
43 |
|
44 |
|
45 |
|
46 |
|
47 |
|
48 |
|
49 |
|
50 |
|
51 |
|
52 |
|
53 |
|
54 |
|
55 |
|
56 |
|
57 |
|
58 |
|
59 |
|
60 |
|
61 | export class GraphQLSchema {
|
62 | description: Maybe<string>;
|
63 | extensions: Maybe<Readonly<GraphQLSchemaExtensions>>;
|
64 | astNode: Maybe<SchemaDefinitionNode>;
|
65 | extensionASTNodes: Maybe<ReadonlyArray<SchemaExtensionNode>>;
|
66 |
|
67 | constructor(config: Readonly<GraphQLSchemaConfig>);
|
68 | getQueryType(): Maybe<GraphQLObjectType>;
|
69 | getMutationType(): Maybe<GraphQLObjectType>;
|
70 | getSubscriptionType(): Maybe<GraphQLObjectType>;
|
71 | getTypeMap(): TypeMap;
|
72 | getType(name: string): Maybe<GraphQLNamedType>;
|
73 |
|
74 | getPossibleTypes(
|
75 | abstractType: GraphQLAbstractType,
|
76 | ): ReadonlyArray<GraphQLObjectType>;
|
77 |
|
78 | getImplementations(
|
79 | interfaceType: GraphQLInterfaceType,
|
80 | ): InterfaceImplementations;
|
81 |
|
82 | // @deprecated: use isSubType instead - will be removed in v16.
|
83 | isPossibleType(
|
84 | abstractType: GraphQLAbstractType,
|
85 | possibleType: GraphQLObjectType,
|
86 | ): boolean;
|
87 |
|
88 | isSubType(
|
89 | abstractType: GraphQLAbstractType,
|
90 | maybeSubType: GraphQLNamedType,
|
91 | ): boolean;
|
92 |
|
93 | getDirectives(): ReadonlyArray<GraphQLDirective>;
|
94 | getDirective(name: string): Maybe<GraphQLDirective>;
|
95 |
|
96 | toConfig(): GraphQLSchemaConfig & {
|
97 | types: Array<GraphQLNamedType>;
|
98 | directives: Array<GraphQLDirective>;
|
99 | extensions: Maybe<Readonly<GraphQLSchemaExtensions>>;
|
100 | extensionASTNodes: ReadonlyArray<SchemaExtensionNode>;
|
101 | assumeValid: boolean;
|
102 | };
|
103 | }
|
104 |
|
105 | interface TypeMap {
|
106 | [key: string]: GraphQLNamedType;
|
107 | }
|
108 |
|
109 | interface InterfaceImplementations {
|
110 | objects: ReadonlyArray<GraphQLObjectType>;
|
111 | interfaces: ReadonlyArray<GraphQLInterfaceType>;
|
112 | }
|
113 |
|
114 | export interface GraphQLSchemaValidationOptions {
|
115 | |
116 |
|
117 |
|
118 |
|
119 |
|
120 |
|
121 |
|
122 | assumeValid?: boolean;
|
123 | }
|
124 |
|
125 | export interface GraphQLSchemaConfig extends GraphQLSchemaValidationOptions {
|
126 | description?: Maybe<string>;
|
127 | query?: Maybe<GraphQLObjectType>;
|
128 | mutation?: Maybe<GraphQLObjectType>;
|
129 | subscription?: Maybe<GraphQLObjectType>;
|
130 | types?: Maybe<Array<GraphQLNamedType>>;
|
131 | directives?: Maybe<Array<GraphQLDirective>>;
|
132 | extensions?: Maybe<Readonly<GraphQLSchemaExtensions>>;
|
133 | astNode?: Maybe<SchemaDefinitionNode>;
|
134 | extensionASTNodes?: Maybe<ReadonlyArray<SchemaExtensionNode>>;
|
135 | }
|
136 |
|
137 |
|
138 |
|
139 |
|
140 | export interface GraphQLSchemaNormalizedConfig extends GraphQLSchemaConfig {
|
141 | description: Maybe<string>;
|
142 | types: Array<GraphQLNamedType>;
|
143 | directives: Array<GraphQLDirective>;
|
144 | extensions: Maybe<Readonly<GraphQLSchemaExtensions>>;
|
145 | extensionASTNodes: Maybe<ReadonlyArray<SchemaExtensionNode>>;
|
146 | assumeValid: boolean;
|
147 | }
|