UNPKG

1.07 kBTypeScriptView Raw
1import type { BundledLanguage } from "shiki" with { "resolution-mode": "import" };
2import type { EnumKeys } from "../enum";
3import type { ReflectionKind } from "../../models/index";
4/**
5 * Default values for TypeDoc options. This object should not be modified.
6 *
7 * @privateRemarks
8 * These are declared here, rather than within the option declaration, so that
9 * they can be exposed as a part of the public API. The unfortunate type declaration
10 * is to control the type which appears in the generated documentation.
11 */
12export declare const OptionDefaults: {
13 excludeNotDocumentedKinds: readonly EnumKeys<typeof ReflectionKind>[];
14 excludeTags: readonly `@${string}`[];
15 blockTags: readonly `@${string}`[];
16 inlineTags: readonly `@${string}`[];
17 modifierTags: readonly `@${string}`[];
18 cascadedModifierTags: readonly `@${string}`[];
19 highlightLanguages: readonly BundledLanguage[];
20 sort: readonly string[];
21 kindSortOrder: readonly EnumKeys<typeof ReflectionKind>[];
22 requiredToBeDocumented: readonly EnumKeys<typeof ReflectionKind>[];
23};