mini-effect
    Preparing search index...

    Interface OptionalSchemaAsync<TWrapped$1, TDefault>

    Optional schema async interface.

    interface OptionalSchemaAsync<
        TWrapped$1 extends
            | BaseSchema<unknown, unknown, BaseIssue<unknown>>
            | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
        TDefault extends DefaultAsync<TWrapped$1, undefined>,
    > {
        "~run": (
            dataset: UnknownDataset,
            config: Config<BaseIssue<unknown>>,
        ) => Promise<
            OutputDataset<
                InferOptionalOutput<TWrapped$1, TDefault>,
                InferIssue<TWrapped$1>,
            >,
        >;
        "~standard": StandardProps<
            InferInput<TWrapped$1>
            | undefined,
            InferOptionalOutput<TWrapped$1, TDefault>,
        >;
        "~types"?: {
            input: InferInput<TWrapped$1> | undefined;
            issue: InferIssue;
            output: InferOptionalOutput;
        };
        async: true;
        default: TDefault;
        expects: `(${TWrapped$1["expects"]} | undefined)`;
        kind: "schema";
        reference: | {
            <
                const TWrapped$1 extends
                    BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            >(
                wrapped: TWrapped$1,
            ): OptionalSchema<TWrapped$1, undefined>;
            <
                const TWrapped$1 extends
                    BaseSchema<unknown, unknown, BaseIssue<unknown>>,
                const TDefault extends unknown,
            >(
                wrapped: TWrapped$1,
                default_: TDefault,
            ): OptionalSchema<TWrapped$1, TDefault>;
        }
        | {
            <
                const TWrapped$1 extends
                    | BaseSchema<unknown, unknown, BaseIssue<unknown>>
                    | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
            >(
                wrapped: TWrapped$1,
            ): OptionalSchemaAsync<TWrapped$1, undefined>;
            <
                const TWrapped$1 extends
                    | BaseSchema<unknown, unknown, BaseIssue<unknown>>
                    | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
                const TDefault extends unknown,
            >(
                wrapped: TWrapped$1,
                default_: TDefault,
            ): OptionalSchemaAsync<TWrapped$1, TDefault>;
        };
        type: "optional";
        wrapped: TWrapped$1;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    ~run ~standard ~types? async default expects kind reference type wrapped

    Properties

    "~run": (
        dataset: UnknownDataset,
        config: Config<BaseIssue<unknown>>,
    ) => Promise<
        OutputDataset<
            InferOptionalOutput<TWrapped$1, TDefault>,
            InferIssue<TWrapped$1>,
        >,
    >

    Parses unknown input values.

    Type Declaration

    "~standard": StandardProps<
        InferInput<TWrapped$1>
        | undefined,
        InferOptionalOutput<TWrapped$1, TDefault>,
    >

    The Standard Schema properties.

    "~types"?: {
        input: InferInput<TWrapped$1> | undefined;
        issue: InferIssue;
        output: InferOptionalOutput;
    }

    The input, output and issue type.

    async: true

    Whether it's async.

    default: TDefault

    The default value.

    expects: `(${TWrapped$1["expects"]} | undefined)`

    The expected property.

    kind: "schema"

    The object kind.

    reference:
        | {
            <
                const TWrapped$1 extends
                    BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            >(
                wrapped: TWrapped$1,
            ): OptionalSchema<TWrapped$1, undefined>;
            <
                const TWrapped$1 extends
                    BaseSchema<unknown, unknown, BaseIssue<unknown>>,
                const TDefault extends unknown,
            >(
                wrapped: TWrapped$1,
                default_: TDefault,
            ): OptionalSchema<TWrapped$1, TDefault>;
        }
        | {
            <
                const TWrapped$1 extends
                    | BaseSchema<unknown, unknown, BaseIssue<unknown>>
                    | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
            >(
                wrapped: TWrapped$1,
            ): OptionalSchemaAsync<TWrapped$1, undefined>;
            <
                const TWrapped$1 extends
                    | BaseSchema<unknown, unknown, BaseIssue<unknown>>
                    | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
                const TDefault extends unknown,
            >(
                wrapped: TWrapped$1,
                default_: TDefault,
            ): OptionalSchemaAsync<TWrapped$1, TDefault>;
        }

    The schema reference.

    Type Declaration

    • {
          <
              const TWrapped$1 extends
                  BaseSchema<unknown, unknown, BaseIssue<unknown>>,
          >(
              wrapped: TWrapped$1,
          ): OptionalSchema<TWrapped$1, undefined>;
          <
              const TWrapped$1 extends
                  BaseSchema<unknown, unknown, BaseIssue<unknown>>,
              const TDefault extends unknown,
          >(
              wrapped: TWrapped$1,
              default_: TDefault,
          ): OptionalSchema<TWrapped$1, TDefault>;
      }
        • <const TWrapped$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>>(
              wrapped: TWrapped$1,
          ): OptionalSchema<TWrapped$1, undefined>

        • Creates an optional schema.

          Type Parameters

          Parameters

          • wrapped: TWrapped$1

            The wrapped schema.

          Returns OptionalSchema<TWrapped$1, undefined>

          An optional schema.

        • <
              const TWrapped$1 extends
                  BaseSchema<unknown, unknown, BaseIssue<unknown>>,
              const TDefault extends unknown,
          >(
              wrapped: TWrapped$1,
              default_: TDefault,
          ): OptionalSchema<TWrapped$1, TDefault>

        • Creates an optional schema.

          Type Parameters

          • const TWrapped$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>
          • const TDefault extends unknown

          Parameters

          • wrapped: TWrapped$1

            The wrapped schema.

          • default_: TDefault

            The default value.

          Returns OptionalSchema<TWrapped$1, TDefault>

          An optional schema.

    • {
          <
              const TWrapped$1 extends
                  | BaseSchema<unknown, unknown, BaseIssue<unknown>>
                  | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
          >(
              wrapped: TWrapped$1,
          ): OptionalSchemaAsync<TWrapped$1, undefined>;
          <
              const TWrapped$1 extends
                  | BaseSchema<unknown, unknown, BaseIssue<unknown>>
                  | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
              const TDefault extends unknown,
          >(
              wrapped: TWrapped$1,
              default_: TDefault,
          ): OptionalSchemaAsync<TWrapped$1, TDefault>;
      }
    type: "optional"

    The schema type.

    wrapped: TWrapped$1

    The wrapped schema.

    Settings

    Member Visibility

    On This Page

    Properties