mini-effect
    Preparing search index...

    Interface ReturnsAction<TInput$1, TSchema>

    Returns action type.

    interface ReturnsAction<
        TInput$1 extends (...args: any[]) => unknown,
        TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
    > {
        "~run": (
            dataset: SuccessDataset<TInput$1>,
            config: Config<BaseIssue<unknown>>,
        ) => OutputDataset<
            (...args: Parameters<TInput$1>) => InferOutput<TSchema>,
            BaseIssue<unknown>,
        >;
        "~types"?: {
            input: TInput$1;
            issue: never;
            output: (...args: Parameters<TInput$1>) => InferOutput<TSchema>;
        };
        async: false;
        kind: "transformation";
        reference: <
            TInput$1 extends (...args: any[]) => unknown,
            TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
        >(
            schema: TSchema,
        ) => ReturnsAction<TInput$1, TSchema>;
        schema: TSchema;
        type: "returns";
    }

    Type Parameters

    • TInput$1 extends (...args: any[]) => unknown
    • TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>>

    Hierarchy (View Summary)

    Index

    Properties

    ~run ~types? async kind reference schema type

    Properties

    "~run": (
        dataset: SuccessDataset<TInput$1>,
        config: Config<BaseIssue<unknown>>,
    ) => OutputDataset<
        (...args: Parameters<TInput$1>) => InferOutput<TSchema>,
        BaseIssue<unknown>,
    >

    Transforms known input values.

    Type Declaration

    "~types"?: {
        input: TInput$1;
        issue: never;
        output: (...args: Parameters<TInput$1>) => InferOutput<TSchema>;
    }

    The input, output and issue type.

    async: false

    Whether it's async.

    kind: "transformation"

    The object kind.

    reference: <
        TInput$1 extends (...args: any[]) => unknown,
        TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
    >(
        schema: TSchema,
    ) => ReturnsAction<TInput$1, TSchema>

    The action reference.

    Type Declaration

      • <
            TInput$1 extends (...args: any[]) => unknown,
            TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
        >(
            schema: TSchema,
        ): ReturnsAction<TInput$1, TSchema>

      • Creates a function return transformation action.

        Type Parameters

        • TInput$1 extends (...args: any[]) => unknown
        • TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>>

        Parameters

        • schema: TSchema

          The arguments schema.

        Returns ReturnsAction<TInput$1, TSchema>

        An returns action.

    schema: TSchema

    The arguments schema.

    type: "returns"

    The action type.

    Settings

    Member Visibility

    On This Page

    Properties