mini-effect
    Preparing search index...

    Interface ExactOptionalSchemaAsync<TWrapped$1, TDefault>

    Exact optional schema async interface.

    interface ExactOptionalSchemaAsync<
        TWrapped$1 extends
            | BaseSchema<unknown, unknown, BaseIssue<unknown>>
            | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
        TDefault extends DefaultAsync<TWrapped$1, never>,
    > {
        "~run": (
            dataset: UnknownDataset,
            config: Config<BaseIssue<unknown>>,
        ) => Promise<
            OutputDataset<InferOutput<TWrapped$1>, InferIssue<TWrapped$1>>,
        >;
        "~standard": StandardProps<InferInput<TWrapped$1>, InferOutput<TWrapped$1>>;
        "~types"?: { input: InferInput; issue: InferIssue; output: InferOutput };
        async: true;
        default: TDefault;
        expects: TWrapped$1["expects"];
        kind: "schema";
        reference:
            | {
                <
                    const TWrapped$1 extends
                        BaseSchema<unknown, unknown, BaseIssue<unknown>>,
                >(
                    wrapped: TWrapped$1,
                ): ExactOptionalSchema<TWrapped$1, undefined>;
                <
                    const TWrapped$1 extends
                        BaseSchema<unknown, unknown, BaseIssue<unknown>>,
                    const TDefault extends unknown,
                >(
                    wrapped: TWrapped$1,
                    default_: TDefault,
                ): ExactOptionalSchema<TWrapped$1, TDefault>;
            }
            | {
                <
                    const TWrapped$1 extends
                        | BaseSchema<unknown, unknown, BaseIssue<unknown>>
                        | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
                >(
                    wrapped: TWrapped$1,
                ): ExactOptionalSchemaAsync<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,
                ): ExactOptionalSchemaAsync<TWrapped$1, TDefault>;
            };
        type: "exact_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<InferOutput<TWrapped$1>, InferIssue<TWrapped$1>>>

    Parses unknown input values.

    Type Declaration

    "~standard": StandardProps<InferInput<TWrapped$1>, InferOutput<TWrapped$1>>

    The Standard Schema properties.

    "~types"?: { input: InferInput; issue: InferIssue; output: InferOutput }

    The input, output and issue type.

    async: true

    Whether it's async.

    default: TDefault

    The default value.

    expects: TWrapped$1["expects"]

    The expected property.

    kind: "schema"

    The object kind.

    reference:
        | {
            <
                const TWrapped$1 extends
                    BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            >(
                wrapped: TWrapped$1,
            ): ExactOptionalSchema<TWrapped$1, undefined>;
            <
                const TWrapped$1 extends
                    BaseSchema<unknown, unknown, BaseIssue<unknown>>,
                const TDefault extends unknown,
            >(
                wrapped: TWrapped$1,
                default_: TDefault,
            ): ExactOptionalSchema<TWrapped$1, TDefault>;
        }
        | {
            <
                const TWrapped$1 extends
                    | BaseSchema<unknown, unknown, BaseIssue<unknown>>
                    | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
            >(
                wrapped: TWrapped$1,
            ): ExactOptionalSchemaAsync<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,
            ): ExactOptionalSchemaAsync<TWrapped$1, TDefault>;
        }

    The schema reference.

    Type Declaration

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

        • Creates an exact optional schema.

          Type Parameters

          Parameters

          • wrapped: TWrapped$1

            The wrapped schema.

          Returns ExactOptionalSchema<TWrapped$1, undefined>

          An exact optional schema.

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

        • Creates an exact 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 ExactOptionalSchema<TWrapped$1, TDefault>

          An exact optional schema.

    • {
          <
              const TWrapped$1 extends
                  | BaseSchema<unknown, unknown, BaseIssue<unknown>>
                  | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
          >(
              wrapped: TWrapped$1,
          ): ExactOptionalSchemaAsync<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,
          ): ExactOptionalSchemaAsync<TWrapped$1, TDefault>;
      }
    type: "exact_optional"

    The schema type.

    wrapped: TWrapped$1

    The wrapped schema.

    Settings

    Member Visibility

    On This Page

    Properties