/
config.ts
57 lines (56 loc) · 1.44 KB
/
config.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
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
import { RawDocumentsConfig } from '@graphql-codegen/visitor-plugin-common';
/**
* @description This plugin generates Flow types based on your `GraphQLSchema` and your GraphQL operations and fragments.
*
* It generates types for your GraphQL documents: Query, Mutation, Subscription and Fragment.
*
* This plugin requires you to use `@graphql-codegen/flow` as well, because it depends on its types.
*/
export interface FlowDocumentsPluginConfig extends RawDocumentsConfig {
/**
* @description Generates Flow types as Exact types.
* @default true
*
* @exampleMarkdown
* ```yml
* generates:
* path/to/file.ts:
* plugins:
* - flow
* config:
* useFlowExactObjects: false
* ```
*/
useFlowExactObjects?: boolean;
/**
* @description Generates read-only Flow types
* @default false
*
* @exampleMarkdown
* ```yml
* generates:
* path/to/file.ts:
* plugins:
* - flow
* config:
* useFlowReadOnlyTypes: true
* ```
*/
useFlowReadOnlyTypes?: boolean;
/**
* @description Flatten fragment spread and inline fragments into a simple selection set before generating.
* @default false
*
* @exampleMarkdown
* ```yml
* generates:
* path/to/file.ts:
* plugins:
* - typescript
* - typescript-operations
* config:
* flattenGeneratedTypes: true
* ```
*/
flattenGeneratedTypes?: boolean;
}