Skip to main content

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: Readonly<Record<keyof CliOptions, Rule>>;

Defined in: sanitize.ts:107

CONFIG_RULES​

const CONFIG_RULES: Readonly<Record<keyof ConfigOptions, Rule>>;

Defined in: sanitize.ts:59

sanitizeConfig()​

function sanitizeConfig(value, rules): SanitizeResult;

Defined in: sanitize.ts:314

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