Interface EvalutateParamtersResult<T, UOAT>

The result of the evaluateParameters function.

Remarks

If the UOAT type parameter is set to true, the args property uses EvaluateParemtersResultArgs_basic instead of EvaluateParemtersResultArgs_v2.

interface EvalutateParamtersResult<
    T extends evaluateParametersParameter[]
    | [evaluateParametersParameter],
    UOAT extends boolean = false,
> {
    args: UOAT extends true
        ? EvaluateParemtersResultArgs_basic<T>
        : {} extends (
            UOAT extends true
                ? EvaluateParemtersResultArgs_basic<T>
                : EvaluateParemtersResultArgs_v2_KeyedOnly<
                    T,
                    IncludeFromTuple<
                        T,
                        objectEvaluateParametersParameter & { key: string },
                    > extends (objectEvaluateParametersParameter & { key: string })[]
                        ? IncludeFromTuple<
                            T,
                            objectEvaluateParametersParameter & { key: string },
                        >
                        : (objectEvaluateParametersParameter & { key: string })[],
                >
        )
            ? UOAT extends true
                ? EvaluateParemtersResultArgs_basic<T>
                : EvaluateParemtersResultArgs_v2_TupleOnly<
                    T,
                    ExcludeFromTuple<
                        T,
                        objectEvaluateParametersParameter & { key: string },
                    >,
                >
            : (
                UOAT extends true
                    ? EvaluateParemtersResultArgs_basic<T>
                    : EvaluateParemtersResultArgs_v2_KeyedOnly<
                        T,
                        IncludeFromTuple<
                            T,
                            objectEvaluateParametersParameter & { key: string },
                        > extends (objectEvaluateParametersParameter & { key: string })[]
                            ? IncludeFromTuple<
                                T,
                                objectEvaluateParametersParameter & { key: string },
                            >
                            : (objectEvaluateParametersParameter & { key: string })[],
                    >
            ) & (
                UOAT extends true
                    ? EvaluateParemtersResultArgs_basic<T>
                    : EvaluateParemtersResultArgs_v2_TupleOnly<
                        T,
                        ExcludeFromTuple<
                            T,
                            objectEvaluateParametersParameter & { key: string },
                        >,
                    >
            );
    err: [Error, any][];
    extra: string;
    params: T;
    get argsK(): UOAT extends true
        ? EvaluateParemtersResultArgs_basic<T>
        : EvaluateParemtersResultArgs_v2_KeyedOnly<
            T,
            IncludeFromTuple<T, objectEvaluateParametersParameter & { key: string }> extends (
                objectEvaluateParametersParameter & { key: string }
            )[]
                ? IncludeFromTuple<
                    T,
                    objectEvaluateParametersParameter & { key: string },
                >
                : (objectEvaluateParametersParameter & { key: string })[],
        >;
    get argsT(): UOAT extends true
        ? EvaluateParemtersResultArgs_basic<T>
        : EvaluateParemtersResultArgs_v2_TupleOnly<
            T,
            ExcludeFromTuple<T, objectEvaluateParametersParameter & { key: string }>,
        >;
}

Type Parameters

T extends evaluateParametersParameter[] | [evaluateParametersParameter]
The paramter types.
UOAT extends boolean = false
If the old args return type should be used. Default is false.

Index

Properties

args err extra params

Accessors

argsK argsT

Properties

args

args: UOAT extends true
    ? EvaluateParemtersResultArgs_basic<T>
    : {} extends (
        UOAT extends true
            ? EvaluateParemtersResultArgs_basic<T>
            : EvaluateParemtersResultArgs_v2_KeyedOnly<
                T,
                IncludeFromTuple<T, objectEvaluateParametersParameter & { key: string }> extends (
                    objectEvaluateParametersParameter & { key: string }
                )[]
                    ? IncludeFromTuple<
                        T,
                        objectEvaluateParametersParameter & { key: string },
                    >
                    : (objectEvaluateParametersParameter & { key: string })[],
            >
    )
        ? UOAT extends true
            ? EvaluateParemtersResultArgs_basic<T>
            : EvaluateParemtersResultArgs_v2_TupleOnly<
                T,
                ExcludeFromTuple<T, objectEvaluateParametersParameter & { key: string }>,
            >
        : (
            UOAT extends true
                ? EvaluateParemtersResultArgs_basic<T>
                : EvaluateParemtersResultArgs_v2_KeyedOnly<
                    T,
                    IncludeFromTuple<
                        T,
                        objectEvaluateParametersParameter & { key: string },
                    > extends (objectEvaluateParametersParameter & { key: string })[]
                        ? IncludeFromTuple<
                            T,
                            objectEvaluateParametersParameter & { key: string },
                        >
                        : (objectEvaluateParametersParameter & { key: string })[],
                >
        ) & (
            UOAT extends true
                ? EvaluateParemtersResultArgs_basic<T>
                : EvaluateParemtersResultArgs_v2_TupleOnly<
                    T,
                    ExcludeFromTuple<
                        T,
                        objectEvaluateParametersParameter & { key: string },
                    >,
                >
        )

The evaluated parameters.

err

err: [Error, any][]

Any errors that occurred.

Default

[]

extra

extra: string

The rest of the commandstring paramter, that was not matched to any parameters.

params

params: T

The original parameters.

Accessors

argsK

get argsK(): UOAT extends true
    ? EvaluateParemtersResultArgs_basic<T>
    : EvaluateParemtersResultArgs_v2_KeyedOnly<
        T,
        IncludeFromTuple<T, objectEvaluateParametersParameter & { key: string }> extends (
            objectEvaluateParametersParameter & { key: string }
        )[]
            ? IncludeFromTuple<
                T,
                objectEvaluateParametersParameter & { key: string },
            >
            : (objectEvaluateParametersParameter & { key: string })[],
    >
The evaluated parameters, but with just the object type, and not the tuple intersection.

The actual value is exactly the same as args, it is only the type that is different.

Returns UOAT extends true
    ? EvaluateParemtersResultArgs_basic<T>
    : EvaluateParemtersResultArgs_v2_KeyedOnly<
        T,
        IncludeFromTuple<T, objectEvaluateParametersParameter & { key: string }> extends (
            objectEvaluateParametersParameter & { key: string }
        )[]
            ? IncludeFromTuple<
                T,
                objectEvaluateParametersParameter & { key: string },
            >
            : (objectEvaluateParametersParameter & { key: string })[],
    >
- Defined in modules/commands/functions/evaluateParameters.ts:56

argsT

get argsT(): UOAT extends true
    ? EvaluateParemtersResultArgs_basic<T>
    : EvaluateParemtersResultArgs_v2_TupleOnly<
        T,
        ExcludeFromTuple<T, objectEvaluateParametersParameter & { key: string }>,
    >
The evaluated parameters, but with just the tuple type, and not the object intersection.

The actual value is exactly the same as args, it is only the type that is different.

Use this if you want to spread it into another tuple.

Returns UOAT extends true
    ? EvaluateParemtersResultArgs_basic<T>
    : EvaluateParemtersResultArgs_v2_TupleOnly<
        T,
        ExcludeFromTuple<T, objectEvaluateParametersParameter & { key: string }>,
    >
- Defined in modules/commands/functions/evaluateParameters.ts:48

Interface EvalutateParamtersResult<T, UOAT>

Remarks

Type Parameters

Index

Properties

Accessors

Properties

args

err

Default

extra

params

Accessors

argsK

argsT

Returns UOAT extends true
    ? EvaluateParemtersResultArgs_basic<T>
    : EvaluateParemtersResultArgs_v2_TupleOnly<
        T,
        ExcludeFromTuple<T, objectEvaluateParametersParameter & { key: string }>,
    >

Settings

On This Page

Interface EvalutateParamtersResult<T, UOAT>

Remarks

Type Parameters

Index

Properties

Accessors

Properties

args

err

Default

extra

params

Accessors

argsK

argsT

Returns UOAT extends true ? EvaluateParemtersResultArgs_basic<T> : EvaluateParemtersResultArgs_v2_TupleOnly< T, ExcludeFromTuple<T, objectEvaluateParametersParameter & { key: string }>, >

Settings

On This Page

Returns UOAT extends true
? EvaluateParemtersResultArgs_basic<T>
: EvaluateParemtersResultArgs_v2_TupleOnly<
T,
ExcludeFromTuple<T, objectEvaluateParametersParameter & { key: string }>,
>