From 9805ed902da0b4b581807f6caf8123635bcb2d15 Mon Sep 17 00:00:00 2001 From: moontai0724 Date: Wed, 9 Oct 2024 07:27:13 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20moontaiw?= =?UTF-8?q?orks/yargs-typebox@c453ba98f248e091b7e8358d9dba31b6147c0cf7=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- functions/getAnyOption.html | 2 +- functions/getArrayOption.html | 2 +- functions/getBooleanOption.html | 2 +- functions/getChoiceOption.html | 2 +- functions/getNumberOption.html | 2 +- functions/getOption.html | 2 +- functions/getOptions.html | 2 +- functions/getStringOption.html | 2 +- types/_internal_.GetChoices.html | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/functions/getAnyOption.html b/functions/getAnyOption.html index e1d8dae..eded669 100644 --- a/functions/getAnyOption.html +++ b/functions/getAnyOption.html @@ -4,4 +4,4 @@
  • overwrites: O = ...

    overwrites for yargs options result

    • Returns {
        alias: undefined | string | readonly string[];
        coerce: undefined | ((arg: any) => any);
        config: undefined | boolean;
        configParser: undefined | ((configPath: string) => object);
        conflicts:
            | undefined
            | string
            | readonly string[]
            | {
                [key: string]: string | readonly string[];
            };
        count: undefined | boolean;
        default: undefined | Static<S>;
        defaultDescription: undefined | string;
        demandOption: string | boolean;
        deprecated: undefined | string | boolean;
        describe: undefined | string;
        global: undefined | boolean;
        group: undefined | string;
        hidden: undefined | boolean;
        implies:
            | undefined
            | string
            | readonly string[]
            | {
                [key: string]: string | readonly string[];
            };
        nargs: undefined | number;
        normalize: undefined | boolean;
        requiresArg: undefined | boolean;
        skipValidation: undefined | boolean;
        type: T;
    } & O

    applicable yargs options in schema and overwrites

    See

    https://yargs.js.org/docs/#api-reference-optionskey-opt

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/getArrayOption.html b/functions/getArrayOption.html index 99b90d2..f36d27a 100644 --- a/functions/getArrayOption.html +++ b/functions/getArrayOption.html @@ -6,4 +6,4 @@

    Type Parameters

    Parameters

    Returns {
        alias: undefined | string | readonly string[];
        coerce: undefined | ((arg: any) => any);
        config: undefined | boolean;
        configParser: undefined | ((configPath: string) => object);
        conflicts:
            | undefined
            | string
            | readonly string[]
            | {
                [key: string]: string | readonly string[];
            };
        count: undefined | boolean;
        default: undefined | Static<S>;
        defaultDescription: undefined | string;
        demandOption: string | boolean;
        deprecated: undefined | string | boolean;
        describe: undefined | string;
        global: undefined | boolean;
        group: undefined | string;
        hidden: undefined | boolean;
        implies:
            | undefined
            | string
            | readonly string[]
            | {
                [key: string]: string | readonly string[];
            };
        nargs: undefined | number;
        normalize: undefined | boolean;
        requiresArg: undefined | boolean;
        skipValidation: undefined | boolean;
        type: "array";
    } & {
        choices: GetChoices<S["items"]>;
    } & O

    applicable yargs options in schema and overwrites

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/getBooleanOption.html b/functions/getBooleanOption.html index a88ad96..f7005d6 100644 --- a/functions/getBooleanOption.html +++ b/functions/getBooleanOption.html @@ -3,4 +3,4 @@

    Type Parameters

    Parameters

    Returns {
        alias: undefined | string | readonly string[];
        coerce: undefined | ((arg: any) => any);
        config: undefined | boolean;
        configParser: undefined | ((configPath: string) => object);
        conflicts:
            | undefined
            | string
            | readonly string[]
            | {
                [key: string]: string | readonly string[];
            };
        count: undefined | boolean;
        default: undefined | Static<S>;
        defaultDescription: undefined | string;
        demandOption: string | boolean;
        deprecated: undefined | string | boolean;
        describe: undefined | string;
        global: undefined | boolean;
        group: undefined | string;
        hidden: undefined | boolean;
        implies:
            | undefined
            | string
            | readonly string[]
            | {
                [key: string]: string | readonly string[];
            };
        nargs: undefined | number;
        normalize: undefined | boolean;
        requiresArg: undefined | boolean;
        skipValidation: undefined | boolean;
        type: "boolean";
    } & O

    applicable yargs options in schema and overwrites

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/getChoiceOption.html b/functions/getChoiceOption.html index 6d689b2..1d2a1f8 100644 --- a/functions/getChoiceOption.html +++ b/functions/getChoiceOption.html @@ -3,4 +3,4 @@

    Type Parameters

    Parameters

    Returns {
        alias: undefined | string | readonly string[];
        coerce: undefined | ((arg: any) => any);
        config: undefined | boolean;
        configParser: undefined | ((configPath: string) => object);
        conflicts:
            | undefined
            | string
            | readonly string[]
            | {
                [key: string]: string | readonly string[];
            };
        count: undefined | boolean;
        default: undefined | Static<S>;
        defaultDescription: undefined | string;
        demandOption: string | boolean;
        deprecated: undefined | string | boolean;
        describe: undefined | string;
        global: undefined | boolean;
        group: undefined | string;
        hidden: undefined | boolean;
        implies:
            | undefined
            | string
            | readonly string[]
            | {
                [key: string]: string | readonly string[];
            };
        nargs: undefined | number;
        normalize: undefined | boolean;
        requiresArg: undefined | boolean;
        skipValidation: undefined | boolean;
        type: "string";
    } & {
        choices: Static<S>[];
    } & O

    applicable yargs options in schema and overwrites

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/getNumberOption.html b/functions/getNumberOption.html index 3cd0fc1..da5871f 100644 --- a/functions/getNumberOption.html +++ b/functions/getNumberOption.html @@ -3,4 +3,4 @@

    Type Parameters

    Parameters

    Returns {
        alias: undefined | string | readonly string[];
        coerce: undefined | ((arg: any) => any);
        config: undefined | boolean;
        configParser: undefined | ((configPath: string) => object);
        conflicts:
            | undefined
            | string
            | readonly string[]
            | {
                [key: string]: string | readonly string[];
            };
        count: undefined | boolean;
        default: undefined | Static<S>;
        defaultDescription: undefined | string;
        demandOption: string | boolean;
        deprecated: undefined | string | boolean;
        describe: undefined | string;
        global: undefined | boolean;
        group: undefined | string;
        hidden: undefined | boolean;
        implies:
            | undefined
            | string
            | readonly string[]
            | {
                [key: string]: string | readonly string[];
            };
        nargs: undefined | number;
        normalize: undefined | boolean;
        requiresArg: undefined | boolean;
        skipValidation: undefined | boolean;
        type: "number";
    } & O

    applicable yargs options in schema and overwrites

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/getOption.html b/functions/getOption.html index 8783b2b..8a2cd2c 100644 --- a/functions/getOption.html +++ b/functions/getOption.html @@ -14,4 +14,4 @@

    Type Parameters

    Parameters

    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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/getOptions.html b/functions/getOptions.html index e7a7de7..52a6102 100644 --- a/functions/getOptions.html +++ b/functions/getOptions.html @@ -5,4 +5,4 @@

    Type Parameters

    Parameters

    Returns Record<keyof Static<Schema>, Options>

    transformed object of yargs options

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/getStringOption.html b/functions/getStringOption.html index ef922ce..190cb1a 100644 --- a/functions/getStringOption.html +++ b/functions/getStringOption.html @@ -3,4 +3,4 @@

    Type Parameters

    Parameters

    Returns {
        alias: undefined | string | readonly string[];
        coerce: undefined | ((arg: any) => any);
        config: undefined | boolean;
        configParser: undefined | ((configPath: string) => object);
        conflicts:
            | undefined
            | string
            | readonly string[]
            | {
                [key: string]: string | readonly string[];
            };
        count: undefined | boolean;
        default: undefined | Static<S>;
        defaultDescription: undefined | string;
        demandOption: string | boolean;
        deprecated: undefined | string | boolean;
        describe: undefined | string;
        global: undefined | boolean;
        group: undefined | string;
        hidden: undefined | boolean;
        implies:
            | undefined
            | string
            | readonly string[]
            | {
                [key: string]: string | readonly string[];
            };
        nargs: undefined | number;
        normalize: undefined | boolean;
        requiresArg: undefined | boolean;
        skipValidation: undefined | boolean;
        type: "string";
    } & O

    applicable yargs options in schema and overwrites

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/types/_internal_.GetChoices.html b/types/_internal_.GetChoices.html index 460932d..8985fef 100644 --- a/types/_internal_.GetChoices.html +++ b/types/_internal_.GetChoices.html @@ -1 +1 @@ -GetChoices | yargs-typebox

    Type Alias GetChoices<T>

    GetChoices<T>: T extends TLiteral
        ? [Static<T>]
        : T extends TUnion<TLiteral[]>
            ? UnionToTuple<Static<T>>
            : never

    Type Parameters

    Settings

    Member Visibility
    +GetChoices | yargs-typebox

    Type Alias GetChoices<T>

    GetChoices<T>: T extends TLiteral
        ? [Static<T>]
        : T extends TUnion<TLiteral[]>
            ? UnionToTuple<Static<T>>
            : never

    Type Parameters

    Settings

    Member Visibility