1 | "use strict";
|
---|
2 |
|
---|
3 | exports.__esModule = true;
|
---|
4 | exports.default = void 0;
|
---|
5 | const defaultOptions = {
|
---|
6 | parse: {
|
---|
7 | /**
|
---|
8 | * This is media type that will be used to parse the input.
|
---|
9 | */
|
---|
10 | mediaType: 'text/plain',
|
---|
11 | /**
|
---|
12 | * Determines how different types of files will be parsed.
|
---|
13 | *
|
---|
14 | * You can add additional parsers of your own, replace an existing one with
|
---|
15 | * your own implementation, or remove any resolver by removing it from the list.
|
---|
16 | * It's recommended to keep the order of parser from most specific ones to most generic ones.
|
---|
17 | */
|
---|
18 | parsers: [],
|
---|
19 | /**
|
---|
20 | * These options are merged with parser plugin instance before the plugin is run.
|
---|
21 | */
|
---|
22 | parserOpts: {}
|
---|
23 | },
|
---|
24 | resolve: {
|
---|
25 | /**
|
---|
26 | * baseURI serves as a base for all relative URL found in ApiDOM references.
|
---|
27 | */
|
---|
28 | baseURI: '',
|
---|
29 | /**
|
---|
30 | * Determines how References will be resolved.
|
---|
31 | *
|
---|
32 | * You can add additional resolvers of your own, replace an existing one with
|
---|
33 | * your own implementation, or remove any resolver by removing it from the list.
|
---|
34 | */
|
---|
35 | resolvers: [],
|
---|
36 | /**
|
---|
37 | * These options are merged with resolver plugin instance before the plugin is run.
|
---|
38 | */
|
---|
39 | resolverOpts: {},
|
---|
40 | /**
|
---|
41 | * Determines strategies how References are identified and processed by resolvers.
|
---|
42 | * Strategy is determined by media type.
|
---|
43 | *
|
---|
44 | * You can add additional resolver strategies of your own, replace an existing one with
|
---|
45 | * your own implementation, or remove any resolve strategy by removing it from the list.
|
---|
46 | */
|
---|
47 | strategies: [],
|
---|
48 | /**
|
---|
49 | * Determines whether external references will be resolved.
|
---|
50 | * If this option is disabled, then none of above resolvers will be called.
|
---|
51 | * Instead, external references will simply be ignored.
|
---|
52 | */
|
---|
53 | external: true,
|
---|
54 | /**
|
---|
55 | * Determines the maximum depth of resolve algorithms.
|
---|
56 | * By default, there is no limit.
|
---|
57 | *
|
---|
58 | * This option tracks the depth of the file tree not the depth of the dereference path.
|
---|
59 | *
|
---|
60 | * It can be set to any positive integer number or zero (0).
|
---|
61 | *
|
---|
62 | * The resolver should throw MaximumResolverDepthError if resolution depth
|
---|
63 | * is exceeded by this option.
|
---|
64 | */
|
---|
65 | maxDepth: +Infinity
|
---|
66 | },
|
---|
67 | dereference: {
|
---|
68 | /**
|
---|
69 | * Determines strategies how ApiDOM is dereferenced.
|
---|
70 | * Strategy is determined by media type or by inspecting ApiDOM to be dereferenced.
|
---|
71 | *
|
---|
72 | * You can add additional dereference strategies of your own, replace an existing one with
|
---|
73 | * your own implementation, or remove any dereference strategy by removing it from the list.
|
---|
74 | */
|
---|
75 | strategies: [],
|
---|
76 | /**
|
---|
77 | * This option accepts an instance of pre-computed ReferenceSet.
|
---|
78 | * If provided it will speed up the dereferencing significantly as the external
|
---|
79 | * resolution doesn't need to happen anymore.
|
---|
80 | */
|
---|
81 | refSet: null,
|
---|
82 | /**
|
---|
83 | * Determines the maximum depth of dereferencing.
|
---|
84 | * By default, there is no limit.
|
---|
85 | *
|
---|
86 | * The maxDepth represents a number of references that needed to be followed
|
---|
87 | * before the eventual value was reached.
|
---|
88 | *
|
---|
89 | * It can be set to any positive integer number or zero (0).
|
---|
90 | *
|
---|
91 | * The dereferencing should throw MaximumDereferenceDepthError if dereferencing depth
|
---|
92 | * is exceeded by this option.
|
---|
93 | */
|
---|
94 | maxDepth: +Infinity
|
---|
95 | },
|
---|
96 | bundle: {
|
---|
97 | /**
|
---|
98 | * Determines strategies how ApiDOM is bundled.
|
---|
99 | * Strategy is determined by media type or by inspecting ApiDOM to be bundled.
|
---|
100 | *
|
---|
101 | * You can add additional bundle strategies of your own, replace an existing one with
|
---|
102 | * your own implementation, or remove any bundle strategy by removing it from the list.
|
---|
103 | */
|
---|
104 | strategies: [],
|
---|
105 | /**
|
---|
106 | * This option accepts an instance of pre-computed ReferenceSet.
|
---|
107 | * If provided it will speed up the bundling significantly as the external
|
---|
108 | * resolution doesn't need to happen anymore.
|
---|
109 | */
|
---|
110 | refSet: null,
|
---|
111 | /**
|
---|
112 | * Determines the maximum depth of bundling.
|
---|
113 | * By default, there is no limit.
|
---|
114 | *
|
---|
115 | * The maxDepth represents a number of references that needed to be followed
|
---|
116 | * before the eventual value was reached.
|
---|
117 | *
|
---|
118 | * It can be set to any positive integer number or zero (0).
|
---|
119 | *
|
---|
120 | * The bundling should throw MaximumBundleDepthError if bundling depth
|
---|
121 | * is exceeded by this option.
|
---|
122 | */
|
---|
123 | maxDepth: +Infinity
|
---|
124 | }
|
---|
125 | };
|
---|
126 | var _default = exports.default = defaultOptions; |
---|