common/src/config.d

Ƭ BuiltinConfigAliases: “rtk:recommended”

A list of built-in config aliases. (This is intended to be a union type if/when other built-in configs are added.)

Ƭ BuiltinConfigModule: object

The exports of a builtin config file.

Ƭ CommandDefaultsConfig: object

Command-specific defaults. Command-line arguments will always override these.

Ƭ CommandName: “redact” | “inspect” | “transform” | “diff”

Valid command names for commands (used with CommandDefaultsConfig).

Ƭ Config: object | ConfigProps

A configuration object. Each configuration file exports an ExportedConfig array containing one or more of these.

Ƭ ConfigListItem: Partial‹object› | Partial‹ConfigProps› | ConfigModule | “rtk:recommended”

An item in the config prop of a config file or ConfigModule.

Ƭ ConfigModule: object

The exports of a config file. There should be only one; config, which may be a Config or ExportedConfig.

Ƭ ConfigProps: object

Properties of a Config object.

Ƭ ExportedConfig: object | object | “rtk:recommended” | object[]

Alias for the config prop of a config file or ConfigModule. See ConfigListItem.

Ƭ FlattenedConfigMarker: object

The symbol attached to a flattened Config.

Ƭ Observable: Observable‹T›

Ƭ RuleConfig: object

Rule-specific configuration. severity and enable will always be usable, otherwise the rest of the properties are defined by the rule.

Ƭ RulesConfig: object

Per-rule configuration.

Ƭ Severity: “error” | “warning” | “info”

Valid severity levels.

Ƭ TransformerDefaultsConfig: object

Per-transformer defaults, keyed on transformer name.

Ƭ TransformerName: “table” | “filter” | “json” | “csv” | “newline” | “redact” | “stack-hash”

A valid transformer name.

• BUILTIN_CONFIGS: Map‹BuiltinConfigAliases, ExportedConfig›

type {Map<BuiltinConfigAliases,ExportedConfig>}

todo move this

• RECOMMENDED_CONFIG_ALIAS: “rtk:recommended”

▸ filterEnabledRules(config: object | ConfigProps): string[]

Given a Config, return a list of rules that are enabled.

Parameters:

Returns: string[]

List of rule IDs

▸ normalizeFlattenedConfig(config: Partial‹object› | Partial‹ConfigProps›): object | ConfigProps

Assign the “flattened config” symbol to complete the config. Add default fields.

Parameters:

Returns: object | ConfigProps

The “final” config

▸ parseConfig(): OperatorFunction‹Partial‹object› | Partial‹ConfigProps› | ConfigModule | “rtk:recommended” | object | object | “rtk:recommended” | object[], object | ConfigProps›

Given an Observable of ExportedConfig arrays, return a single, flattened Config object. Config object will have a kFlattenedConfig Symbol property set to true.

todo Eliminate extra empty properties

Returns: OperatorFunction‹Partial‹object› | Partial‹ConfigProps› | ConfigModule | “rtk:recommended” | object | object | “rtk:recommended” | object[], object | ConfigProps›