mini-effect
    Preparing search index...

    Interface TupleWithRestSchema<TItems$1, TRest$1, TMessage>

    Tuple with rest schema interface.

    interface TupleWithRestSchema<
        TItems$1 extends TupleItems,
        TRest$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
        TMessage extends ErrorMessage<TupleWithRestIssue> | undefined,
    > {
        "~run": (
            dataset: UnknownDataset,
            config: Config<BaseIssue<unknown>>,
        ) => OutputDataset<
            [...InferTupleOutput<TItems$1>[], ...InferOutput<TRest$1>[]],
            TupleWithRestIssue | InferTupleIssue<TItems$1> | InferIssue<TRest$1>,
        >;
        "~standard": StandardProps<
            [...InferTupleInput<TItems$1>[], ...InferInput<TRest$1>[]],
            [...InferTupleOutput<TItems$1>[], ...InferOutput<TRest$1>[]],
        >;
        "~types"?: {
            input: [...InferTupleInput<TItems$1>[], ...InferInput<TRest$1>[]];
            issue:
                | TupleWithRestIssue
                | InferTupleIssue<TItems$1>
                | InferIssue<TRest$1>;
            output: [...InferTupleOutput<TItems$1>[], ...InferOutput<TRest$1>[]];
        };
        async: false;
        expects: "Array";
        items: TItems$1;
        kind: "schema";
        message: TMessage;
        reference: {
            <
                const TItems$1 extends TupleItems,
                const TRest$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            >(
                items: TItems$1,
                rest: TRest$1,
            ): TupleWithRestSchema<TItems$1, TRest$1, undefined>;
            <
                const TItems$1 extends TupleItems,
                const TRest$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
                const TMessage extends ErrorMessage<TupleWithRestIssue> | undefined,
            >(
                items: TItems$1,
                rest: TRest$1,
                message: TMessage,
            ): TupleWithRestSchema<TItems$1, TRest$1, TMessage>;
        };
        rest: TRest$1;
        type: "tuple_with_rest";
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    ~run ~standard ~types? async expects items kind message reference rest type

    Properties

    "~run": (
        dataset: UnknownDataset,
        config: Config<BaseIssue<unknown>>,
    ) => OutputDataset<
        [...InferTupleOutput<TItems$1>[], ...InferOutput<TRest$1>[]],
        TupleWithRestIssue | InferTupleIssue<TItems$1> | InferIssue<TRest$1>,
    >

    Parses unknown input values.

    Type Declaration

    "~standard": StandardProps<
        [...InferTupleInput<TItems$1>[], ...InferInput<TRest$1>[]],
        [...InferTupleOutput<TItems$1>[], ...InferOutput<TRest$1>[]],
    >

    The Standard Schema properties.

    "~types"?: {
        input: [...InferTupleInput<TItems$1>[], ...InferInput<TRest$1>[]];
        issue: TupleWithRestIssue | InferTupleIssue<TItems$1> | InferIssue<TRest$1>;
        output: [...InferTupleOutput<TItems$1>[], ...InferOutput<TRest$1>[]];
    }

    The input, output and issue type.

    async: false

    Whether it's async.

    expects: "Array"

    The expected property.

    items: TItems$1

    The items schema.

    kind: "schema"

    The object kind.

    message: TMessage

    The error message.

    reference: {
        <
            const TItems$1 extends TupleItems,
            const TRest$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
        >(
            items: TItems$1,
            rest: TRest$1,
        ): TupleWithRestSchema<TItems$1, TRest$1, undefined>;
        <
            const TItems$1 extends TupleItems,
            const TRest$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            const TMessage extends ErrorMessage<TupleWithRestIssue> | undefined,
        >(
            items: TItems$1,
            rest: TRest$1,
            message: TMessage,
        ): TupleWithRestSchema<TItems$1, TRest$1, TMessage>;
    }

    The schema reference.

    Type Declaration

      • <
            const TItems$1 extends TupleItems,
            const TRest$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
        >(
            items: TItems$1,
            rest: TRest$1,
        ): TupleWithRestSchema<TItems$1, TRest$1, undefined>

      • Creates a tuple with rest schema.

        Type Parameters

        Parameters

        • items: TItems$1

          The items schema.

        • rest: TRest$1

          The rest schema.

        Returns TupleWithRestSchema<TItems$1, TRest$1, undefined>

        A tuple with rest schema.

      • <
            const TItems$1 extends TupleItems,
            const TRest$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            const TMessage extends ErrorMessage<TupleWithRestIssue> | undefined,
        >(
            items: TItems$1,
            rest: TRest$1,
            message: TMessage,
        ): TupleWithRestSchema<TItems$1, TRest$1, TMessage>

      • Creates a tuple with rest schema.

        Type Parameters

        Parameters

        • items: TItems$1

          The items schema.

        • rest: TRest$1

          The rest schema.

        • message: TMessage

          The error message.

        Returns TupleWithRestSchema<TItems$1, TRest$1, TMessage>

        A tuple with rest schema.

    rest: TRest$1

    The rest schema.

    type: "tuple_with_rest"

    The schema type.

    Settings

    Member Visibility

    On This Page

    Properties