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