mini-effect
    Preparing search index...

    Interface LazySchemaAsync<TWrapped$1>

    Lazy schema async interface.

    interface LazySchemaAsync<
        TWrapped$1 extends
            | BaseSchema<unknown, unknown, BaseIssue<unknown>>
            | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
    > {
        "~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;
        expects: "unknown";
        getter: (input: unknown) => MaybePromise<TWrapped$1>;
        kind: "schema";
        reference:
            | (
                <
                    const TWrapped$1 extends
                        BaseSchema<unknown, unknown, BaseIssue<unknown>>,
                >(
                    getter: (input: unknown) => TWrapped$1,
                ) => LazySchema<TWrapped$1>
            )
            | (
                <
                    const TWrapped$1 extends
                        | BaseSchema<unknown, unknown, BaseIssue<unknown>>
                        | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
                >(
                    getter: (input: unknown) => MaybePromise<TWrapped$1>,
                ) => LazySchemaAsync<TWrapped$1>
            );
        type: "lazy";
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

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

    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.

    expects: "unknown"

    The expected property.

    getter: (input: unknown) => MaybePromise<TWrapped$1>

    The schema getter.

    kind: "schema"

    The object kind.

    reference:
        | (
            <
                const TWrapped$1 extends
                    BaseSchema<unknown, unknown, BaseIssue<unknown>>,
            >(
                getter: (input: unknown) => TWrapped$1,
            ) => LazySchema<TWrapped$1>
        )
        | (
            <
                const TWrapped$1 extends
                    | BaseSchema<unknown, unknown, BaseIssue<unknown>>
                    | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
            >(
                getter: (input: unknown) => MaybePromise<TWrapped$1>,
            ) => LazySchemaAsync<TWrapped$1>
        )

    The schema reference.

    Type Declaration

    • <const TWrapped$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>>(
          getter: (input: unknown) => TWrapped$1,
      ) => LazySchema<TWrapped$1>
        • <const TWrapped$1 extends BaseSchema<unknown, unknown, BaseIssue<unknown>>>(
              getter: (input: unknown) => TWrapped$1,
          ): LazySchema<TWrapped$1>

        • Creates a lazy schema.

          Type Parameters

          Parameters

          • getter: (input: unknown) => TWrapped$1

            The schema getter.

          Returns LazySchema<TWrapped$1>

          A lazy schema.

    • <
          const TWrapped$1 extends
              | BaseSchema<unknown, unknown, BaseIssue<unknown>>
              | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
      >(
          getter: (input: unknown) => MaybePromise<TWrapped$1>,
      ) => LazySchemaAsync<TWrapped$1>
    type: "lazy"

    The schema type.

    Settings

    Member Visibility

    On This Page

    Properties