sanitize

SanitizeResult

Defined in: sanitize.ts:26

Properties

unknownKeys

unknownKeys: number;

Defined in: sanitize.ts:28

value

value: Record<string, unknown>;

Defined in: sanitize.ts:27

---

Rule

type Rule =
  | {
      kind: "any";
    }
  | {
      kind: "enum";
      values: readonly string[];
    }
  | {
      kind: "formatter";
    }
  | {
      kind: "loaders";
    }
  | {
      kind: "map";
      value: Rule;
    }
  | {
      fields: Record<string, Rule>;
      kind: "object";
    }
  | {
      kind: "opaque";
    }
  | {
      kind: "path";
    }
  | {
      kind: "pointer";
    }
  | {
      kind: "scalar";
    }
  | {
      kind: "string";
    }
  | {
      kind: "url";
    };

Defined in: sanitize.ts:12

---

CLI_RULES

const CLI_RULES: object;

Defined in: sanitize.ts:93

Type Declaration

base

readonly base: object = url;

base.kind

kind: "url";

config

readonly config: object = scalar;

config.kind

kind: "scalar";

deprecated

deprecated: Rule;

diff

readonly diff: Rule;

force

readonly force: object = scalar;

force.kind

kind: "scalar";

formatter

formatter: object;

formatter.kind

kind: "formatter";

groupByDirective

readonly groupByDirective: object = string;

groupByDirective.kind

kind: "string";

hierarchy

readonly hierarchy: Rule;

homepage

readonly homepage: object = path;

homepage.kind

kind: "path";

index

readonly index: object = scalar;

index.kind

kind: "scalar";

link

readonly link: object = path;

link.kind

kind: "path";

mdxParser

readonly mdxParser: object = formatter;

mdxParser.kind

kind: "formatter";

noParentType

readonly noParentType: object = scalar;

noParentType.kind

kind: "scalar";

noSectionId

readonly noSectionId: object = scalar;

noSectionId.kind

kind: "scalar";

noTypeBadges

readonly noTypeBadges: object = scalar;

noTypeBadges.kind

kind: "scalar";

only

readonly only: object = string;

only.kind

kind: "string";

pretty

readonly pretty: object = scalar;

pretty.kind

kind: "scalar";

root

readonly root: object = path;

root.kind

kind: "path";

schema

readonly schema: object = pointer;

schema.kind

kind: "pointer";

skip

readonly skip: object = string;

skip.kind

kind: "string";

telemetry

readonly telemetry: object = scalar;

telemetry.kind

kind: "scalar";

tmp

readonly tmp: object = path;

tmp.kind

kind: "path";

---

CONFIG_RULES

const CONFIG_RULES: object;

Defined in: sanitize.ts:45

Type Declaration

baseURL

readonly baseURL: object = url;

baseURL.kind

kind: "url";

customDirective

readonly customDirective: object;

customDirective.kind

readonly kind: "map" = "map";

customDirective.value

readonly value: object = any;

customDirective.value.kind

kind: "any";

decorators

readonly decorators: object;

decorators.kind

readonly kind: "map" = "map";

decorators.value

readonly value: object = any;

decorators.value.kind

kind: "any";

diffMethod

readonly diffMethod: Rule;

docOptions

readonly docOptions: object;

docOptions.fields

readonly fields: object;

docOptions.fields.categorySort

readonly categorySort: object;

docOptions.fields.categorySort.kind

readonly kind: "enum" = "enum";

docOptions.fields.categorySort.values

readonly values: readonly ["natural"];

docOptions.fields.frontMatter

readonly frontMatter: object;

docOptions.fields.frontMatter.kind

readonly kind: "map" = "map";

docOptions.fields.frontMatter.value

readonly value: object = any;

docOptions.fields.frontMatter.value.kind

kind: "any";

docOptions.fields.generatorFrameworkName

readonly generatorFrameworkName: object = string;

docOptions.fields.generatorFrameworkName.kind

kind: "string";

docOptions.fields.generatorFrameworkVersion

readonly generatorFrameworkVersion: object = string;

docOptions.fields.generatorFrameworkVersion.kind

kind: "string";

docOptions.fields.index

readonly index: object = scalar;

docOptions.fields.index.kind

kind: "scalar";

docOptions.fields.sectionHeaderId

readonly sectionHeaderId: object = scalar;

docOptions.fields.sectionHeaderId.kind

kind: "scalar";

docOptions.kind

readonly kind: "object" = "object";

force

readonly force: object = scalar;

force.kind

kind: "scalar";

formatter

formatter: object;

formatter.kind

kind: "formatter";

groupByDirective

readonly groupByDirective: object;

groupByDirective.fields

readonly fields: object;

groupByDirective.fields.directive

readonly directive: object = string;

groupByDirective.fields.directive.kind

kind: "string";

groupByDirective.fields.fallback

readonly fallback: object = string;

groupByDirective.fields.fallback.kind

kind: "string";

groupByDirective.fields.field

readonly field: object = string;

groupByDirective.fields.field.kind

kind: "string";

groupByDirective.kind

readonly kind: "object" = "object";

homepage

readonly homepage: object = path;

homepage.kind

kind: "path";

id

readonly id: object = string;

id.kind

kind: "string";

linkRoot

readonly linkRoot: object = path;

linkRoot.kind

kind: "path";

loaders

readonly loaders: object;

loaders.kind

readonly kind: "loaders" = "loaders";

mdxParser

readonly mdxParser: object = formatter;

mdxParser.kind

kind: "formatter";

metatags

readonly metatags: object;

metatags.kind

readonly kind: "map" = "map";

metatags.value

readonly value: object = string;

metatags.value.kind

kind: "string";

onlyDocDirective

readonly onlyDocDirective: object = string;

onlyDocDirective.kind

kind: "string";

outputAdapter

readonly outputAdapter: object;

outputAdapter.kind

readonly kind: "opaque" = "opaque";

pretty

readonly pretty: object = scalar;

pretty.kind

kind: "scalar";

printTypeOptions

readonly printTypeOptions: object;

printTypeOptions.fields

readonly fields: object;

printTypeOptions.fields.deprecated

deprecated: Rule;

printTypeOptions.fields.exampleSection

readonly exampleSection: object;

printTypeOptions.fields.exampleSection.kind

readonly kind: "map" = "map";

printTypeOptions.fields.exampleSection.value

readonly value: object = string;

printTypeOptions.fields.exampleSection.value.kind

kind: "string";

printTypeOptions.fields.hierarchy

readonly hierarchy: Rule;

printTypeOptions.fields.parentTypePrefix

readonly parentTypePrefix: object = scalar;

printTypeOptions.fields.parentTypePrefix.kind

kind: "scalar";

printTypeOptions.fields.typeBadges

readonly typeBadges: object = scalar;

printTypeOptions.fields.typeBadges.kind

kind: "scalar";

printTypeOptions.kind

readonly kind: "object" = "object";

rootPath

readonly rootPath: object = path;

rootPath.kind

kind: "path";

schema

readonly schema: object = pointer;

schema.kind

kind: "pointer";

skipDocDirective

readonly skipDocDirective: object = string;

skipDocDirective.kind

kind: "string";

telemetry

readonly telemetry: object = scalar;

telemetry.kind

kind: "scalar";

tmpDir

readonly tmpDir: object = path;

tmpDir.kind

kind: "path";

---

sanitizeConfig()

function sanitizeConfig(value, rules): SanitizeResult;

Defined in: sanitize.ts:300

Sanitizes a config source. Top-level keys without a rule are dropped and counted in unknownKeys.

Parameters

value

unknown

rules

Record<string, Rule>

Returns

SanitizeResult