Function getOption

getOption<T, O>(schema, overwrites?): T extends TNumber
    ? ReturnType<typeof getNumberOption>
    : T extends TString
        ? ReturnType<typeof getStringOption>
        : T extends TBoolean
            ? ReturnType<typeof getBooleanOption>
            : T extends TUnion<TLiteral[]>
                ? ReturnType<typeof getChoiceOption>
                : T extends TArray
                    ? ReturnType<typeof getArrayOption>
                    : O
Handy function to get yargs options from TypeBox schema without having to manually call corresponding transformers.

Handlable TypeBox schema types:
- TNumber
- TString
- TBoolean
- TArray
- TLiteral
- TUnion<TLiteral[]>
Schemas that are not supported will still be able to transform, but only pick supported yargs properties from schema.
Type Parameters
- T extends TSchema
- O extends Options = object
Parameters
- schema: T
  Any TypeBox schema that could be transformed to yargs options.
- Optionaloverwrites: O
  overwrites for yargs options result
Returns T extends TNumber
    ? ReturnType<typeof getNumberOption>
    : T extends TString
        ? ReturnType<typeof getStringOption>
        : T extends TBoolean
            ? ReturnType<typeof getBooleanOption>
            : T extends TUnion<TLiteral[]>
                ? ReturnType<typeof getChoiceOption>
                : T extends TArray
                    ? ReturnType<typeof getArrayOption>
                    : O
applicable yargs options in schema and overwrites
- Defined in src/get-option.ts:41

Function getOption

Type Parameters

Parameters

Settings