mini-effect
    Preparing search index...

    Interface FunctionSchema<TMessage>

    Function schema interface.

    interface FunctionSchema<
        TMessage extends ErrorMessage<FunctionIssue>
        | undefined,
    > {
        "~run": (
            dataset: UnknownDataset,
            config: Config<BaseIssue<unknown>>,
        ) => OutputDataset<(...args: unknown[]) => unknown, FunctionIssue>;
        "~standard": StandardProps<
            (...args: unknown[]) => unknown,
            (...args: unknown[]) => unknown,
        >;
        "~types"?: {
            input: (...args: unknown[]) => unknown;
            issue: FunctionIssue;
            output: (...args: unknown[]) => unknown;
        };
        async: false;
        expects: "Function";
        kind: "schema";
        message: TMessage;
        reference: {
            (): FunctionSchema<undefined>;
            <const TMessage extends ErrorMessage<FunctionIssue> | undefined>(
                message: TMessage,
            ): FunctionSchema<TMessage>;
        };
        type: "function";
    }

    Type Parameters

    Hierarchy (View Summary)

    • BaseSchema<
          (...args: unknown[]) => unknown,
          (...args: unknown[]) => unknown,
          FunctionIssue,
      >
      • FunctionSchema
    Index

    Properties

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

    Properties

    "~run": (
        dataset: UnknownDataset,
        config: Config<BaseIssue<unknown>>,
    ) => OutputDataset<(...args: unknown[]) => unknown, FunctionIssue>

    Parses unknown input values.

    Type Declaration

    "~standard": StandardProps<
        (...args: unknown[]) => unknown,
        (...args: unknown[]) => unknown,
    >

    The Standard Schema properties.

    "~types"?: {
        input: (...args: unknown[]) => unknown;
        issue: FunctionIssue;
        output: (...args: unknown[]) => unknown;
    }

    The input, output and issue type.

    async: false

    Whether it's async.

    expects: "Function"

    The expected property.

    kind: "schema"

    The object kind.

    message: TMessage

    The error message.

    reference: {
        (): FunctionSchema<undefined>;
        <const TMessage extends ErrorMessage<FunctionIssue> | undefined>(
            message: TMessage,
        ): FunctionSchema<TMessage>;
    }

    The schema reference.

    Type Declaration

    type: "function"

    The schema type.

    Settings

    Member Visibility

    On This Page

    Properties