Function normalizeOptionValue

normalizeOptionValue<
    T extends
        | (
            { type: "string"; customType?: OptionCustomType<"string"> | undefined; choices?: string[] | undefined; string?: boolean | undefined; alias?: MaybeReadonly<string[]> | undefined; description?: string | undefined; required?: boolean | undefined; requires?: MaybeReadonly<...> | undefined; conflicts?: MaybeReadonly<...>...
        )
        | (
            { type: "number"; customType?: "number" | undefined; choices?: number[] | undefined; string?: boolean | undefined; alias?: MaybeReadonly<string[]> | undefined; description?: string | undefined; required?: boolean | undefined; requires?: MaybeReadonly<...> | undefined; conflicts?: MaybeReadonly<...> | undefined; } & ...
        )
        | (
            { type: "boolean"; customType?: "boolean" | undefined; choices?: boolean[] | undefined; string?: boolean | undefined; alias?: MaybeReadonly<string[]> | undefined; description?: string | undefined; required?: boolean | undefined; requires?: MaybeReadonly<...> | undefined; conflicts?: MaybeReadonly<...> | undefined; }...
        )
        | (
            { type: "secret"; customType?: OptionCustomType<"secret"> | undefined; choices?: string[] | undefined; string?: boolean | undefined; alias?: MaybeReadonly<string[]> | undefined; description?: string | undefined; required?: boolean | undefined; requires?: MaybeReadonly<...> | undefined; conflicts?: MaybeReadonly<...>...
        )
        | (
            { type: "array"; customType?: "array" | undefined; choices?: string[][] | undefined; string?: boolean | undefined; alias?: MaybeReadonly<string[]> | undefined; description?: string | undefined; required?: boolean | undefined; requires?: MaybeReadonly<...> | undefined; conflicts?: MaybeReadonly<...> | undefined; } & ...
        ),
>(
    value: unknown,
    config?: T,
): undefined | OptionConfigPrimitiveType<T>
Normalizes a value for an option based on the option's configuration:
- Coerce empty strings to undefined.
- Split string values into arrays for array options and trim whitespace.
- Parse numbers and booleans.
Type Parameters
- T extends
      | (
          { type: "string"; customType?: OptionCustomType<"string"> | undefined; choices?: string[] | undefined; string?: boolean | undefined; alias?: MaybeReadonly<string[]> | undefined; description?: string | undefined; required?: boolean | undefined; requires?: MaybeReadonly<...> | undefined; conflicts?: MaybeReadonly<...>...
      )
      | (
          { type: "number"; customType?: "number" | undefined; choices?: number[] | undefined; string?: boolean | undefined; alias?: MaybeReadonly<string[]> | undefined; description?: string | undefined; required?: boolean | undefined; requires?: MaybeReadonly<...> | undefined; conflicts?: MaybeReadonly<...> | undefined; } & ...
      )
      | (
          { type: "boolean"; customType?: "boolean" | undefined; choices?: boolean[] | undefined; string?: boolean | undefined; alias?: MaybeReadonly<string[]> | undefined; description?: string | undefined; required?: boolean | undefined; requires?: MaybeReadonly<...> | undefined; conflicts?: MaybeReadonly<...> | undefined; }...
      )
      | (
          { type: "secret"; customType?: OptionCustomType<"secret"> | undefined; choices?: string[] | undefined; string?: boolean | undefined; alias?: MaybeReadonly<string[]> | undefined; description?: string | undefined; required?: boolean | undefined; requires?: MaybeReadonly<...> | undefined; conflicts?: MaybeReadonly<...>...
      )
      | (
          { type: "array"; customType?: "array" | undefined; choices?: string[][] | undefined; string?: boolean | undefined; alias?: MaybeReadonly<string[]> | undefined; description?: string | undefined; required?: boolean | undefined; requires?: MaybeReadonly<...> | undefined; conflicts?: MaybeReadonly<...> | undefined; } & ...
      )
Parameters
- value: unknown
  The value to prepare.
- Optionalconfig: T
  The option configuration for the value.
Returns undefined | OptionConfigPrimitiveType<T>
- The prepared value.
- Defined in packages/cli/src/core/options/options.ts:385

Function normalizeOptionValue

Type Parameters

Parameters

Returns undefined | OptionConfigPrimitiveType<T>

Settings