1 | import { PluginFunction, PluginValidateFn } from '@graphql-codegen/plugin-helpers';
|
2 | /**
|
3 | * @description This plugin generates a GraphQL introspection file based on your GraphQL schema.
|
4 | */
|
5 | export interface IntrospectionPluginConfig {
|
6 | /**
|
7 | * @description Set to `true` in order to minify the JSON output.
|
8 | * @default false
|
9 | *
|
10 | * @exampleMarkdown
|
11 | * ```yaml {6}
|
12 | * generates:
|
13 | * introspection.json:
|
14 | * plugins:
|
15 | * - introspection
|
16 | * config:
|
17 | * minify: true
|
18 | * ```
|
19 | */
|
20 | minify?: boolean;
|
21 | /**
|
22 | * @description Whether to include descriptions in the introspection result.
|
23 | * @default true
|
24 | */
|
25 | descriptions?: boolean;
|
26 | /**
|
27 | * @description Whether to include `specifiedByUrl` in the introspection result.
|
28 | * @default false
|
29 | */
|
30 | specifiedByUrl?: boolean;
|
31 | /**
|
32 | * @description Whether to include `isRepeatable` flag on directives.
|
33 | * @default true
|
34 | */
|
35 | directiveIsRepeatable?: boolean;
|
36 | /**
|
37 | * @description Whether to include `description` field on schema.
|
38 | * @default false
|
39 | */
|
40 | schemaDescription?: boolean;
|
41 | federation?: boolean;
|
42 | }
|
43 | export declare const plugin: PluginFunction<IntrospectionPluginConfig>;
|
44 | export declare const validate: PluginValidateFn<any>;
|