-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathllms-api.txt
More file actions
15329 lines (8909 loc) · 252 KB
/
llms-api.txt
File metadata and controls
15329 lines (8909 loc) · 252 KB
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# GraphQL-Markdown API Reference
> Comprehensive API reference for GraphQL-Markdown packages, CLI commands, and integration helpers.
Endpoints, CLI commands, and helper utilities documented here mirror the content published under /api/ on graphql-markdown.dev.
## cli
This module provides the CLI functionality for generating documentation from GraphQL schemas.
It exports utilities to run the documentation generator both programmatically and via CLI.
## See
[GraphQL Markdown Documentation](https://graphql-markdown.dev)
## GraphQLMarkdownCliType \{#graphqlmarkdownclitype\}
```ts
type GraphQLMarkdownCliType = CommanderStatic;
```
Defined in: index.ts:29
Type representing the GraphQL Markdown CLI.
### See
[GraphQL Markdown Documentation](https://graphql-markdown.dev)
---
## getGraphQLMarkdownCli() \{#getgraphqlmarkdowncli\}
```ts
function getGraphQLMarkdownCli(
options,
loggerModule?,
customMdxParser?,
): CommanderStatic;
```
Defined in: index.ts:84
Configures and returns the GraphQL Markdown CLI.
### Parameters
#### options
`GraphQLMarkdownCliOptions`
Options for configuring the GraphQL Markdown CLI.
#### loggerModule?
`string`
Optional logger module to use.
#### customMdxParser?
`string` \| `boolean`
Optional MDX parser configuration.
### Returns
`CommanderStatic`
The configured CLI instance.
### Example
```typescript
const cli = getGraphQLMarkdownCli({ id: "custom" }, "custom-logger", true);
await cli.parseAsync(process.argv);
```
---
## runGraphQLMarkdown() \{#rungraphqlmarkdown\}
```ts
function runGraphQLMarkdown(options, cliOptions, loggerModule?): Promise<void>;
```
Defined in: index.ts:47
Runs the GraphQL Markdown CLI to generate documentation from a GraphQL schema.
### Parameters
#### options
`GraphQLMarkdownCliOptions`
Options for configuring the GraphQL Markdown CLI.
#### cliOptions
`CliOptions`
Command-line options passed to the CLI.
#### loggerModule?
`string`
Optional logger module to use.
### Returns
`Promise`<`void`>
### Example
```typescript
await runGraphQLMarkdown(
{ id: "custom" },
{ schema: "./schema.graphql", root: "./docs" },
"custom-logger",
);
```
---
## main
Entry point for the GraphQL Markdown CLI.
Loads configuration from graphql-config and sets up command-line interface.
## EXTENSION_NAME \{#extension_name\}
```ts
const EXTENSION_NAME: "graphql-markdown";
```
Defined in: main.ts:24
Name of the GraphQL Markdown extension for graphql-config
---
## graphQLConfigExtension \{#graphqlconfigextension\}
```ts
const graphQLConfigExtension: GraphQLExtensionDeclaration;
```
Defined in: main.ts:30
GraphQL config extension declaration for GraphQL Markdown
### Returns
Extension configuration object
---
## config
Configuration management for GraphQL Markdown.
This module handles all aspects of configuration including:
- Loading and merging configuration from multiple sources
- Validating configuration values
- Providing defaults for missing options
- Processing special configuration options (directives, deprecated items, etc)
The configuration follows this precedence (highest to lowest):
1. CLI arguments
2. Config file options
3. GraphQL Config options
4. Default values
## DeprecatedOption \{#deprecatedoption\}
Defined in: core/src/config.ts:102
Options for handling deprecated items in the schema.
- DEFAULT: Show deprecated items normally
- GROUP: Group deprecated items separately
- SKIP: Exclude deprecated items from documentation
### Example
```typescript
const deprecatedHandling = DeprecatedOption.GROUP;
```
### Enumeration Members
#### DEFAULT \{#default\}
```ts
DEFAULT: "default";
```
Defined in: core/src/config.ts:103
#### GROUP \{#group\}
```ts
GROUP: "group";
```
Defined in: core/src/config.ts:104
#### SKIP \{#skip\}
```ts
SKIP: "skip";
```
Defined in: core/src/config.ts:105
---
## DiffMethod \{#diffmethod\}
Defined in: core/src/config.ts:84
Diff methods used to determine how schema changes are processed.
- NONE: No diffing is performed
- FORCE: Force regeneration of documentation regardless of schema changes
### Example
```typescript
const diffMethod = DiffMethod.FORCE;
```
### Enumeration Members
#### FORCE \{#force\}
```ts
FORCE: "FORCE";
```
Defined in: core/src/config.ts:86
#### NONE \{#none\}
```ts
NONE: "NONE";
```
Defined in: core/src/config.ts:85
---
## TypeHierarchy \{#typehierarchy\}
Defined in: core/src/config.ts:66
Type hierarchy options for organizing schema documentation.
- API: Groups types by their role in the API (Query, Mutation, etc.)
- ENTITY: Groups types by their entity relationships
- FLAT: No grouping, all types in a flat structure
### Example
```typescript
const hierarchy = TypeHierarchy.API;
```
### Enumeration Members
#### API \{#api\}
```ts
API: "api";
```
Defined in: core/src/config.ts:67
#### ENTITY \{#entity\}
```ts
ENTITY: "entity";
```
Defined in: core/src/config.ts:68
#### FLAT \{#flat\}
```ts
FLAT: "flat";
```
Defined in: core/src/config.ts:69
---
## ASSET_HOMEPAGE_LOCATION \{#asset_homepage_location\}
```ts
const ASSET_HOMEPAGE_LOCATION: string;
```
Defined in: core/src/config.ts:123
Location of the default homepage template.
---
## DEFAULT_HIERARCHY \{#default_hierarchy\}
```ts
const DEFAULT_HIERARCHY: object;
```
Defined in: core/src/config.ts:134
Default hierarchy configuration using the API hierarchy type.
### Type Declaration
#### api \{#api-1\}
```ts
api: object = {};
```
---
## DEFAULT_OPTIONS \{#default_options\}
```ts
const DEFAULT_OPTIONS: Readonly<
Pick<ConfigOptions, "customDirective" | "groupByDirective" | "loaders"> &
Required<
Omit<
ConfigOptions,
| "customDirective"
| "groupByDirective"
| "loaders"
| "mdxParser"
| "printTypeOptions"
>
>
> &
object;
```
Defined in: core/src/config.ts:143
Default configuration options used when no user options are provided.
These values serve as fallbacks for any missing configuration.
### Type Declaration
#### printTypeOptions
```ts
printTypeOptions: Required<Omit<ConfigPrintTypeOptions, "hierarchy">> & object;
```
##### Type Declaration
###### hierarchy
```ts
hierarchy: Required<Pick<TypeHierarchyObjectType, API>>;
```
### See
Options for the complete configuration interface
---
## DOCS_URL \{#docs_url\}
```ts
const DOCS_URL: "https://graphql-markdown.dev/docs";
```
Defined in: core/src/config.ts:112
Documentation website URL for reference in error messages and help text.
---
## PACKAGE_NAME \{#package_name\}
```ts
const PACKAGE_NAME: "@graphql-markdown/docusaurus";
```
Defined in: core/src/config.ts:118
Default package name used for temporary directory creation and identification.
---
## buildConfig() \{#buildconfig\}
```ts
function buildConfig(configFileOpts, cliOpts?, id?): Promise<Options>;
```
Defined in: core/src/config.ts:820
### Parameters
#### configFileOpts
`Maybe`<`ConfigOptions`>
#### cliOpts?
`Maybe`<`CliOptions`>
#### id?
`Maybe`<`string`> = `"default"`
### Returns
`Promise`<`Options`>
---
## getCustomDirectives() \{#getcustomdirectives\}
```ts
function getCustomDirectives(
customDirectiveOptions,
skipDocDirective?,
): Maybe<CustomDirective>;
```
Defined in: core/src/config.ts:392
Processes custom directives, filtering out any that should be skipped.
Validates that each custom directive has the correct format with required functions.
### Parameters
#### customDirectiveOptions
`Maybe`<`CustomDirective`>
The custom directive configuration object
#### skipDocDirective?
`Maybe`<`DirectiveName`[]>
Array of directive names that should be skipped
### Returns
`Maybe`<`CustomDirective`>
The filtered custom directives object, or `undefined` if empty/invalid
### Throws
Error if a custom directive has an invalid format
### Example
```typescript
// Valid custom directive with descriptor function
const customDirectives = {
example: {
tag: (value) => `Example: ${value}`,
},
note: {
descriptor: () => "Note items",
},
};
// Filter out the "example" directive, keeping "note"
const filteredDirectives = getCustomDirectives(customDirectives, ["example"]);
console.log(filteredDirectives); // { note: { descriptor: [Function] } }
// Invalid format - will throw an error
getCustomDirectives({ example: { invalid: true } }, []);
// Error: Wrong format for plugin custom directive "example"...
```
### See
[DOCS_URL](#docs_url)/advanced/custom-directive for custom directive format documentation
---
## getDiffMethod() \{#getdiffmethod\}
```ts
function getDiffMethod(diff): TypeDiffMethod;
```
Defined in: core/src/config.ts:447
### Parameters
#### diff
`TypeDiffMethod`
### Returns
`TypeDiffMethod`
---
## getDocDirective() \{#getdocdirective\}
```ts
function getDocDirective(name): DirectiveName;
```
Defined in: core/src/config.ts:217
Retrieves a directive name from a string by parsing and validating the format.
Directive names should be prefixed with '@' (e.g., '@example').
### Parameters
#### name
`Maybe`<`DirectiveName`>
The directive name as a string, which should follow the format '@directiveName'
### Returns
`DirectiveName`
The validated directive name without the '@' prefix
### Throws
Error if the directive name format is invalid
### Example
```typescript
const directive = getDocDirective("@example");
console.log(directive); // "example"
// Invalid - will throw an error
getDocDirective("example"); // Error: Invalid "example"
```
---
## getDocOptions() \{#getdocoptions\}
```ts
function getDocOptions(cliOpts?, configOptions?): Required<ConfigDocOptions>;
```
Defined in: core/src/config.ts:486
Builds the document options by merging CLI options, config file options, and defaults.
Handles index generation flag and front matter configuration.
### Parameters
#### cliOpts?
`Maybe`<`CliOptions` & `Omit`<`DeprecatedCliOptions`, `"never"`>>
CLI options for document generation
#### configOptions?
`Maybe`<`ConfigDocOptions` & `Omit`<`DeprecatedConfigDocOptions`, `"never"`>>
Config file options for document generation
### Returns
`Required`<`ConfigDocOptions`>
The resolved document options with all required fields
### Example
```typescript
const cliOptions = { index: true };
const configOptions = { frontMatter: { sidebar_label: "API" } };
const docOptions = getDocOptions(cliOptions, configOptions);
console.log(docOptions);
// {
// index: true,
// frontMatter: { sidebar_label: 'API' }
// }
```
---
## getForcedDiffMethod() \{#getforceddiffmethod\}
```ts
function getForcedDiffMethod(): TypeDiffMethod;
```
Defined in: core/src/config.ts:437
Returns FORCE as the diff method.
This function is used when documentation should be forcefully regenerated.
### Returns
`TypeDiffMethod`
The FORCE diff method
### Example
```typescript
const method = getForcedDiffMethod();
console.log(method); // "FORCE"
```
### See
[DiffMethod](#diffmethod) for available diff methods
---
## getNormalizedDiffMethod() \{#getnormalizeddiffmethod\}
```ts
function getNormalizedDiffMethod(diff): TypeDiffMethod;
```
Defined in: core/src/config.ts:441
### Parameters
#### diff
`TypeDiffMethod`
### Returns
`TypeDiffMethod`
---
## getOnlyDocDirectives() \{#getonlydocdirectives\}
```ts
function getOnlyDocDirectives(cliOpts, configFileOpts): DirectiveName[];
```
Defined in: core/src/config.ts:248
Retrieves the list of "only" directives from CLI and config options.
These directives specify which schema elements should be included in the documentation.
### Parameters
#### cliOpts
`Maybe`<`CliOptions`>
CLI options containing "only" directives
#### configFileOpts
`Maybe`<`Pick`<`ConfigOptions`, `"onlyDocDirective"`>>
Config file options containing "onlyDocDirective"
### Returns
`DirectiveName`[]
An array of validated "only" directives (without '@' prefix)
### Example
```typescript
const cliOptions = { only: ["@example", "@internal"] };
const configOptions = { onlyDocDirective: ["@auth"] };
const onlyDirectives = getOnlyDocDirectives(cliOptions, configOptions);
console.log(onlyDirectives); // ["example", "internal", "auth"]
```
### See
[getDocDirective](#getdocdirective) for directive name validation
---
## getPrintTypeOptions() \{#getprinttypeoptions\}
```ts
function getPrintTypeOptions(
cliOpts,
configOptions,
): Required<ConfigPrintTypeOptions>;
```
Defined in: core/src/config.ts:671
Builds the print type options by merging CLI options, config file options, and defaults.
Handles various formatting options for type documentation.
### Parameters
#### cliOpts
`Maybe`<`CliOptions` & `Omit`<`DeprecatedCliOptions`, `"never"`>>
CLI options for print type configuration
#### configOptions
`Maybe`<`ConfigPrintTypeOptions` & `Omit`<`DeprecatedConfigPrintTypeOptions`, `"never"`>>
Config file options for print type configuration
### Returns
`Required`<`ConfigPrintTypeOptions`>
The resolved print type options with all required fields
### Example
```typescript
const cliOptions = { noCode: true, deprecated: "group" };
const configOptions = {
exampleSection: true,
hierarchy: "entity",
};
const printOptions = getPrintTypeOptions(cliOptions, configOptions);
console.log(printOptions);
// {
// codeSection: false, // Disabled via noCode CLI flag
// deprecated: "group", // From CLI
// exampleSection: true, // From config
// parentTypePrefix: true, // Default value
// relatedTypeSection: true, // Default value
// typeBadges: true, // Default value
// hierarchy: { entity: {} } // Parsed from config
// }
```
### See
- [DeprecatedOption](#deprecatedoption) for deprecated handling options
- [getTypeHierarchyOption](#gettypehierarchyoption) for hierarchy resolution
---
## getSkipDocDirectives() \{#getskipdocdirectives\}
```ts
function getSkipDocDirectives(cliOpts, configFileOpts): DirectiveName[];
```
Defined in: core/src/config.ts:283
Retrieves the list of "skip" directives from CLI and config options.
These directives specify which schema elements should be excluded from the documentation.
Additionally, if deprecated handling is set to SKIP, adds the "deprecated" directive.
### Parameters
#### cliOpts
`Maybe`<`CliOptions`>
CLI options containing "skip" directives
#### configFileOpts
`Maybe`<`Pick`<`ConfigOptions`, `"printTypeOptions"` \| `"skipDocDirective"`>>
Config file options containing "skipDocDirective" and potentially "printTypeOptions.deprecated"
### Returns
`DirectiveName`[]
An array of validated "skip" directives (without '@' prefix)
### Example
```typescript
const cliOptions = { skip: ["@internal"], deprecated: "skip" };
const configOptions = { skipDocDirective: ["@auth"] };
const skipDirectives = getSkipDocDirectives(cliOptions, configOptions);
console.log(skipDirectives); // ["internal", "auth", "deprecated"]
```
### See
- [getDocDirective](#getdocdirective) for directive name validation
- [DeprecatedOption](#deprecatedoption) for deprecated handling options
---
## getTypeHierarchyOption() \{#gettypehierarchyoption\}
```ts
function getTypeHierarchyOption(
cliOption?,
configOption?,
): Maybe<Partial<Record<TypeHierarchyValueType, TypeHierarchyTypeOptions>>>;
```
Defined in: core/src/config.ts:539
Resolves the type hierarchy configuration by merging CLI and config file options.
Validates that CLI and config don't specify conflicting hierarchy types.
### Parameters
#### cliOption?
`Maybe`<`TypeHierarchyValueType`>
The hierarchy option specified via CLI (string value)
#### configOption?
`Maybe`<`TypeHierarchyType`>
The hierarchy option from the config file (string or object)
### Returns
`Maybe`<`Partial`<`Record`<`TypeHierarchyValueType`, `TypeHierarchyTypeOptions`>>>
The resolved type hierarchy object
### Throws
Error if CLI and config specify conflicting hierarchy types
### Example
```typescript
// Using hierarchy from CLI (string format)
const hierarchy1 = getTypeHierarchyOption("api", undefined);
console.log(hierarchy1); // { api: {} }
// Using hierarchy from config (object format)
const hierarchy2 = getTypeHierarchyOption(undefined, {
entity: { User: ["posts"] },
});
console.log(hierarchy2); // { entity: { User: ["posts"] } }
// Error case - conflicting hierarchies
getTypeHierarchyOption("api", { entity: {} });
// Error: Hierarchy option mismatch in CLI flag 'api' and config 'entity'
```
### See
[TypeHierarchy](#typehierarchy) for available hierarchy types
---
## getVisibilityDirectives() \{#getvisibilitydirectives\}
```ts
function getVisibilityDirectives(cliOpts, configFileOpts): object;
```
Defined in: core/src/config.ts:337
Combines and validates visibility directives (only and skip) from both CLI and config sources.
Ensures that no directive appears in both "only" and "skip" lists simultaneously.
### Parameters
#### cliOpts
`Maybe`<`CliOptions`>
CLI options containing "only" and "skip" directives
#### configFileOpts
`Maybe`<`Pick`<`ConfigOptions`, `"onlyDocDirective"` \| `"printTypeOptions"` \| `"skipDocDirective"`>>
Config file options containing directive configurations
### Returns
`object`
An object with validated "onlyDocDirective" and "skipDocDirective" arrays
#### onlyDocDirective
```ts
onlyDocDirective: DirectiveName[];
```
#### skipDocDirective
```ts
skipDocDirective: DirectiveName[];
```
### Throws
Error if the same directive appears in both "only" and "skip" lists
### Example
```typescript
const cliOptions = { only: ["@example"], skip: ["@internal"] };
const configOptions = { onlyDocDirective: ["@auth"] };
const visibilityDirectives = getVisibilityDirectives(cliOptions, configOptions);
console.log(visibilityDirectives);
// {
// onlyDocDirective: ["example", "auth"],
// skipDocDirective: ["internal"]
// }
// Invalid - will throw an error
getVisibilityDirectives({ only: ["@example"], skip: ["@example"] }, {}); // Error: The same directive cannot be declared in 'onlyDocDirective' and 'skipDocDirective'.
```
### See
[getOnlyDocDirectives](#getonlydocdirectives) and [getSkipDocDirectives](#getskipdocdirectives) for directive retrieval
---
## parseDeprecatedDocOptions() \{#parsedeprecateddocoptions\}
```ts
function parseDeprecatedDocOptions(
_cliOpts,
_configOptions,
): Record<string, never>;
```
Defined in: core/src/config.ts:459
Placeholder function for handling deprecated document options.
Currently returns an empty object as these options are deprecated.
### Parameters
#### \_cliOpts
`Maybe`<`Omit`<`DeprecatedCliOptions`, `"never"`>>
Deprecated CLI options (unused)
#### \_configOptions
`Maybe`<`Omit`<`DeprecatedConfigDocOptions`, `"never"`>>
Deprecated config options (unused)
### Returns
`Record`<`string`, `never`>
An empty object
---
## parseDeprecatedPrintTypeOptions() \{#parsedeprecatedprinttypeoptions\}
```ts
function parseDeprecatedPrintTypeOptions(
cliOpts,
configOptions,
): Record<string, never>;
```
Defined in: core/src/config.ts:593
Handles deprecated print type options.
Emits deprecation warnings when legacy section toggle options are detected
from CLI flags or config file values.
### Parameters
#### cliOpts