mini-effect
    Preparing search index...

    Interface CustomSchemaAsync<TInput$1, TMessage>

    Custom schema async interface.

    interface CustomSchemaAsync<
        TInput$1,
        TMessage extends ErrorMessage<CustomIssue> | undefined,
    > {
        "~run": (
            dataset: UnknownDataset,
            config: Config<BaseIssue<unknown>>,
        ) => Promise<OutputDataset<TInput$1, CustomIssue>>;
        "~standard": StandardProps<TInput$1, TInput$1>;
        "~types"?: { input: TInput$1; issue: CustomIssue; output: TInput$1 };
        async: true;
        check: CheckAsync;
        expects: "unknown";
        kind: "schema";
        message: TMessage;
        reference:
            | {
                <TInput$1>(check: Check): CustomSchema<TInput$1, undefined>;
                <
                    TInput$1,
                    const TMessage extends
                        ErrorMessage<CustomIssue> | undefined =
                        | ErrorMessage<CustomIssue>
                        | undefined,
                >(
                    check: Check,
                    message: TMessage,
                ): CustomSchema<TInput$1, TMessage>;
            }
            | {
                <TInput$1>(check: CheckAsync): CustomSchemaAsync<TInput$1, undefined>;
                <
                    TInput$1,
                    const TMessage extends
                        ErrorMessage<CustomIssue> | undefined =
                        | ErrorMessage<CustomIssue>
                        | undefined,
                >(
                    check: CheckAsync,
                    message: TMessage,
                ): CustomSchemaAsync<TInput$1, TMessage>;
            };
        type: "custom";
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    "~run": (
        dataset: UnknownDataset,
        config: Config<BaseIssue<unknown>>,
    ) => Promise<OutputDataset<TInput$1, CustomIssue>>

    Parses unknown input values.

    Type Declaration

    "~standard": StandardProps<TInput$1, TInput$1>

    The Standard Schema properties.

    "~types"?: { input: TInput$1; issue: CustomIssue; output: TInput$1 }

    The input, output and issue type.

    async: true

    Whether it's async.

    check: CheckAsync

    The type check function.

    expects: "unknown"

    The expected property.

    kind: "schema"

    The object kind.

    message: TMessage

    The error message.

    reference:
        | {
            <TInput$1>(check: Check): CustomSchema<TInput$1, undefined>;
            <
                TInput$1,
                const TMessage extends
                    ErrorMessage<CustomIssue> | undefined =
                    | ErrorMessage<CustomIssue>
                    | undefined,
            >(
                check: Check,
                message: TMessage,
            ): CustomSchema<TInput$1, TMessage>;
        }
        | {
            <TInput$1>(check: CheckAsync): CustomSchemaAsync<TInput$1, undefined>;
            <
                TInput$1,
                const TMessage extends
                    ErrorMessage<CustomIssue> | undefined =
                    | ErrorMessage<CustomIssue>
                    | undefined,
            >(
                check: CheckAsync,
                message: TMessage,
            ): CustomSchemaAsync<TInput$1, TMessage>;
        }

    The schema reference.

    Type Declaration

    • {
          <TInput$1>(check: Check): CustomSchema<TInput$1, undefined>;
          <
              TInput$1,
              const TMessage extends
                  ErrorMessage<CustomIssue> | undefined =
                  | ErrorMessage<CustomIssue>
                  | undefined,
          >(
              check: Check,
              message: TMessage,
          ): CustomSchema<TInput$1, TMessage>;
      }
        • <TInput$1>(check: Check): CustomSchema<TInput$1, undefined>

        • Creates a custom schema.

          Type Parameters

          • TInput$1

          Parameters

          • check: Check

            The type check function.

          Returns CustomSchema<TInput$1, undefined>

          A custom schema.

        • <
              TInput$1,
              const TMessage extends
                  ErrorMessage<CustomIssue> | undefined =
                  | ErrorMessage<CustomIssue>
                  | undefined,
          >(
              check: Check,
              message: TMessage,
          ): CustomSchema<TInput$1, TMessage>

        • Creates a custom schema.

          Type Parameters

          Parameters

          • check: Check

            The type check function.

          • message: TMessage

            The error message.

          Returns CustomSchema<TInput$1, TMessage>

          A custom schema.

    • {
          <TInput$1>(check: CheckAsync): CustomSchemaAsync<TInput$1, undefined>;
          <
              TInput$1,
              const TMessage extends
                  ErrorMessage<CustomIssue> | undefined =
                  | ErrorMessage<CustomIssue>
                  | undefined,
          >(
              check: CheckAsync,
              message: TMessage,
          ): CustomSchemaAsync<TInput$1, TMessage>;
      }
    type: "custom"

    The schema type.

    Settings

    Member Visibility

    On This Page

    Properties