mini-effect
    Preparing search index...

    Interface SetSchemaAsync<TValue$1, TMessage>

    Set schema async interface.

    interface SetSchemaAsync<
        TValue$1 extends
            | BaseSchema<unknown, unknown, BaseIssue<unknown>>
            | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
        TMessage extends ErrorMessage<SetIssue>
        | undefined,
    > {
        "~run": (
            dataset: UnknownDataset,
            config: Config<BaseIssue<unknown>>,
        ) => Promise<
            OutputDataset<
                InferSetOutput<TValue$1>,
                SetIssue | InferIssue<TValue$1>,
            >,
        >;
        "~standard": StandardProps<
            InferSetInput<TValue$1>,
            InferSetOutput<TValue$1>,
        >;
        "~types"?: {
            input: InferSetInput;
            issue: SetIssue | InferIssue<TValue$1>;
            output: InferSetOutput;
        };
        async: true;
        expects: "Set";
        kind: "schema";
        message: TMessage;
        reference: | {
            <
                const TValue$1 extends
                    BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            >(
                value: TValue$1,
            ): SetSchema<TValue$1, undefined>;
            <
                const TValue$1 extends
                    BaseSchema<unknown, unknown, BaseIssue<unknown>>,
                const TMessage extends ErrorMessage<SetIssue>
                | undefined,
            >(
                value: TValue$1,
                message: TMessage,
            ): SetSchema<TValue$1, TMessage>;
        }
        | {
            <
                const TValue$1 extends
                    | BaseSchema<unknown, unknown, BaseIssue<unknown>>
                    | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
            >(
                value: TValue$1,
            ): SetSchemaAsync<TValue$1, undefined>;
            <
                const TValue$1 extends
                    | BaseSchema<unknown, unknown, BaseIssue<unknown>>
                    | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
                const TMessage extends ErrorMessage<SetIssue>
                | undefined,
            >(
                value: TValue$1,
                message: TMessage,
            ): SetSchemaAsync<TValue$1, TMessage>;
        };
        type: "set";
        value: TValue$1;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    "~run": (
        dataset: UnknownDataset,
        config: Config<BaseIssue<unknown>>,
    ) => Promise<
        OutputDataset<InferSetOutput<TValue$1>, SetIssue | InferIssue<TValue$1>>,
    >

    Parses unknown input values.

    Type Declaration

    "~standard": StandardProps<InferSetInput<TValue$1>, InferSetOutput<TValue$1>>

    The Standard Schema properties.

    "~types"?: {
        input: InferSetInput;
        issue: SetIssue | InferIssue<TValue$1>;
        output: InferSetOutput;
    }

    The input, output and issue type.

    async: true

    Whether it's async.

    expects: "Set"

    The expected property.

    kind: "schema"

    The object kind.

    message: TMessage

    The error message.

    reference:
        | {
            <
                const TValue$1 extends
                    BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            >(
                value: TValue$1,
            ): SetSchema<TValue$1, undefined>;
            <
                const TValue$1 extends
                    BaseSchema<unknown, unknown, BaseIssue<unknown>>,
                const TMessage extends ErrorMessage<SetIssue>
                | undefined,
            >(
                value: TValue$1,
                message: TMessage,
            ): SetSchema<TValue$1, TMessage>;
        }
        | {
            <
                const TValue$1 extends
                    | BaseSchema<unknown, unknown, BaseIssue<unknown>>
                    | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
            >(
                value: TValue$1,
            ): SetSchemaAsync<TValue$1, undefined>;
            <
                const TValue$1 extends
                    | BaseSchema<unknown, unknown, BaseIssue<unknown>>
                    | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
                const TMessage extends ErrorMessage<SetIssue>
                | undefined,
            >(
                value: TValue$1,
                message: TMessage,
            ): SetSchemaAsync<TValue$1, TMessage>;
        }

    The schema reference.

    Type Declaration

    • {
          <
              const TValue$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
          >(
              value: TValue$1,
          ): SetSchema<TValue$1, undefined>;
          <
              const TValue$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
              const TMessage extends ErrorMessage<SetIssue> | undefined,
          >(
              value: TValue$1,
              message: TMessage,
          ): SetSchema<TValue$1, TMessage>;
      }
        • <const TValue$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>>(
              value: TValue$1,
          ): SetSchema<TValue$1, undefined>

        • Creates a set schema.

          Type Parameters

          Parameters

          • value: TValue$1

            The value schema.

          Returns SetSchema<TValue$1, undefined>

          A set schema.

        • <
              const TValue$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>,
              const TMessage extends ErrorMessage<SetIssue> | undefined,
          >(
              value: TValue$1,
              message: TMessage,
          ): SetSchema<TValue$1, TMessage>

        • Creates a set schema.

          Type Parameters

          Parameters

          • value: TValue$1

            The value schema.

          • message: TMessage

            The error message.

          Returns SetSchema<TValue$1, TMessage>

          A set schema.

    • {
          <
              const TValue$1 extends
                  | BaseSchema<unknown, unknown, BaseIssue<unknown>>
                  | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
          >(
              value: TValue$1,
          ): SetSchemaAsync<TValue$1, undefined>;
          <
              const TValue$1 extends
                  | BaseSchema<unknown, unknown, BaseIssue<unknown>>
                  | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
              const TMessage extends ErrorMessage<SetIssue>
              | undefined,
          >(
              value: TValue$1,
              message: TMessage,
          ): SetSchemaAsync<TValue$1, TMessage>;
      }
    type: "set"

    The schema type.

    value: TValue$1

    The set value schema.

    Settings

    Member Visibility

    On This Page

    Properties