@@ -21,9 +21,9 @@ _Introspection_
21
21
22
22
<ul class =" apiIndex " >
23
23
<li >
24
- <a href="#introspectionquery ">
25
- <pre>var introspectionQuery </pre>
26
- A GraphQL introspection query containing enough information to reproduce a type system.
24
+ <a href="#getintrospectionquery ">
25
+ <pre>function getIntrospectionQuery </pre>
26
+ Builds a GraphQL introspection query containing enough information to reproduce a type system.
27
27
</a>
28
28
</li >
29
29
<li >
@@ -105,13 +105,33 @@ _Value Validation_
105
105
106
106
## Introspection
107
107
108
- ### introspectionQuery
108
+ ### getIntrospectionQuery
109
109
110
110
``` js
111
- var introspectionQuery: string;
111
+ interface IntrospectionOptions {
112
+ // Whether to include descriptions in the introspection result.
113
+ // Default: true
114
+ descriptions?: boolean;
115
+
116
+ // Whether to include `specifiedByUrl` in the introspection result.
117
+ // Default: false
118
+ specifiedByUrl?: boolean;
119
+
120
+ // Whether to include `isRepeatable` flag on directives.
121
+ // Default: false
122
+ directiveIsRepeatable?: boolean;
123
+
124
+ // Whether to include `description` field on schema.
125
+ // Default: false
126
+ schemaDescription?: boolean;
127
+ }
128
+
129
+ function getIntrospectionQuery (
130
+ options : IntrospectionOptions
131
+ ): string;
112
132
```
113
133
114
- A GraphQL query that queries a server's introspection system for enough
134
+ Build a GraphQL query that queries a server's introspection system for enough
115
135
information to reproduce that server's type system.
116
136
117
137
### buildClientSchema
0 commit comments