Interface IntersectSchemaAsync<TOptions$1, TMessage>

Intersect schema async interface.

interface IntersectSchemaAsync<
    TOptions$1 extends IntersectOptionsAsync,
    TMessage extends ErrorMessage<IntersectIssue> | undefined,
> {
    "~run": (
        dataset: UnknownDataset,
        config: Config<BaseIssue<unknown>>,
    ) => Promise<
        OutputDataset<
            InferIntersectOutput<TOptions$1>,
            IntersectIssue | InferIssue<TOptions$1[number]>,
        >,
    >;
    "~standard": StandardProps<
        InferIntersectInput<TOptions$1>,
        InferIntersectOutput<TOptions$1>,
    >;
    "~types"?: {
        input: InferIntersectInput;
        issue: IntersectIssue | InferIssue<TOptions$1[number]>;
        output: InferIntersectOutput;
    };
    async: true;
    expects: string;
    kind: "schema";
    message: TMessage;
    options: TOptions$1;
    reference: | {
        <const TOptions$1 extends IntersectOptions>(
            options: TOptions$1,
        ): IntersectSchema<TOptions$1, undefined>;
        <
            const TOptions$1 extends IntersectOptions,
            const TMessage extends ErrorMessage<IntersectIssue> | undefined,
        >(
            options: TOptions$1,
            message: TMessage,
        ): IntersectSchema<TOptions$1, TMessage>;
    }
    | {
        <const TOptions$1 extends IntersectOptionsAsync>(
            options: TOptions$1,
        ): IntersectSchemaAsync<TOptions$1, undefined>;
        <
            const TOptions$1 extends IntersectOptionsAsync,
            const TMessage extends ErrorMessage<IntersectIssue> | undefined,
        >(
            options: TOptions$1,
            message: TMessage,
        ): IntersectSchemaAsync<TOptions$1, TMessage>;
    };
    type: "intersect";
}

Type Parameters

TOptions$1 extends IntersectOptionsAsync
TMessage extends ErrorMessage<IntersectIssue> | undefined

Hierarchy (View Summary)

BaseSchemaAsync<
    InferIntersectInput<TOptions$1>,
    InferIntersectOutput<TOptions$1>,
    IntersectIssue | InferIssue<TOptions$1[number]>,
>
- IntersectSchemaAsync

Index

Properties

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

Properties

`Readonly` `Internal`~run

"~run": (
    dataset: UnknownDataset,
    config: Config<BaseIssue<unknown>>,
) => Promise<
    OutputDataset<
        InferIntersectOutput<TOptions$1>,
        IntersectIssue | InferIssue<TOptions$1[number]>,
    >,
>

Parses unknown input values.

Type Declaration

- (
      dataset: UnknownDataset,
      config: Config<BaseIssue<unknown>>,
  ): Promise<
      OutputDataset<
          InferIntersectOutput<TOptions$1>,
          IntersectIssue | InferIssue<TOptions$1[number]>,
      >,
  >
- Parameters
  - dataset: UnknownDataset
    The input dataset.
  - config: Config<BaseIssue<unknown>>
    The configuration.
  Returns Promise<
      OutputDataset<
          InferIntersectOutput<TOptions$1>,
          IntersectIssue | InferIssue<TOptions$1[number]>,
      >,
  >
  The output dataset.

`Readonly` `Internal`~standard

"~standard": StandardProps<
InferIntersectInput<TOptions$1>,
InferIntersectOutput<TOptions$1>,
>

The Standard Schema properties.

`Optional` `Readonly` `Internal`~types

"~types"?: {
    input: InferIntersectInput;
    issue: IntersectIssue | InferIssue<TOptions$1[number]>;
    output: InferIntersectOutput;
}

The input, output and issue type.

`Readonly`async

async: true

Whether it's async.

`Readonly`expects

expects: string

The expected property.

`Readonly`kind

kind: "schema"

The object kind.

`Readonly`message

message: TMessage

The error message.

`Readonly`options

options: TOptions$1

The intersect options.

`Readonly`reference

reference:
    | {
        <const TOptions$1 extends IntersectOptions>(
            options: TOptions$1,
        ): IntersectSchema<TOptions$1, undefined>;
        <
            const TOptions$1 extends IntersectOptions,
            const TMessage extends ErrorMessage<IntersectIssue> | undefined,
        >(
            options: TOptions$1,
            message: TMessage,
        ): IntersectSchema<TOptions$1, TMessage>;
    }
    | {
        <const TOptions$1 extends IntersectOptionsAsync>(
            options: TOptions$1,
        ): IntersectSchemaAsync<TOptions$1, undefined>;
        <
            const TOptions$1 extends IntersectOptionsAsync,
            const TMessage extends ErrorMessage<IntersectIssue> | undefined,
        >(
            options: TOptions$1,
            message: TMessage,
        ): IntersectSchemaAsync<TOptions$1, TMessage>;
    }

The schema reference.

Type Declaration

{
    <const TOptions$1 extends IntersectOptions>(
        options: TOptions$1,
    ): IntersectSchema<TOptions$1, undefined>;
    <
        const TOptions$1 extends IntersectOptions,
        const TMessage extends ErrorMessage<IntersectIssue> | undefined,
    >(
        options: TOptions$1,
        message: TMessage,
    ): IntersectSchema<TOptions$1, TMessage>;
}
- - <const TOptions$1 extends IntersectOptions>(
    options: TOptions$1,
    ): IntersectSchema<TOptions$1, undefined>
  - Creates an intersect schema.
    Type Parameters
    - const TOptions$1 extends IntersectOptions
    Parameters
    - options: TOptions$1
      The intersect options.
    Returns IntersectSchema<TOptions$1, undefined>
    An intersect schema.
  - <
        const TOptions$1 extends IntersectOptions,
        const TMessage extends ErrorMessage<IntersectIssue> | undefined,
    >(
        options: TOptions$1,
        message: TMessage,
    ): IntersectSchema<TOptions$1, TMessage>
  - Creates an intersect schema.
    Type Parameters
    - const TOptions$1 extends IntersectOptions
    - const TMessage extends ErrorMessage<IntersectIssue> | undefined
    Parameters
    - options: TOptions$1
      The intersect options.
    - message: TMessage
      The error message.
    Returns IntersectSchema<TOptions$1, TMessage>
    An intersect schema.
{
    <const TOptions$1 extends IntersectOptionsAsync>(
        options: TOptions$1,
    ): IntersectSchemaAsync<TOptions$1, undefined>;
    <
        const TOptions$1 extends IntersectOptionsAsync,
        const TMessage extends ErrorMessage<IntersectIssue> | undefined,
    >(
        options: TOptions$1,
        message: TMessage,
    ): IntersectSchemaAsync<TOptions$1, TMessage>;
}
- - <const TOptions$1 extends IntersectOptionsAsync>(
    options: TOptions$1,
    ): IntersectSchemaAsync<TOptions$1, undefined>
  - Creates an intersect schema.
    Type Parameters
    - const TOptions$1 extends IntersectOptionsAsync
    Parameters
    - options: TOptions$1
      The intersect options.
    Returns IntersectSchemaAsync<TOptions$1, undefined>
    An intersect schema.
  - <
        const TOptions$1 extends IntersectOptionsAsync,
        const TMessage extends ErrorMessage<IntersectIssue> | undefined,
    >(
        options: TOptions$1,
        message: TMessage,
    ): IntersectSchemaAsync<TOptions$1, TMessage>
  - Creates an intersect schema.
    Type Parameters
    - const TOptions$1 extends IntersectOptionsAsync
    - const TMessage extends ErrorMessage<IntersectIssue> | undefined
    Parameters
    - options: TOptions$1
      The intersect options.
    - message: TMessage
      The error message.
    Returns IntersectSchemaAsync<TOptions$1, TMessage>
    An intersect schema.

`Readonly`type

type: "intersect"

The schema type.

Interface IntersectSchemaAsync<TOptions$1, TMessage>

Type Parameters

Hierarchy (View Summary)

Index

Properties

Properties

`Readonly` `Internal`~run

Type Declaration

Parameters

Returns Promise<
    OutputDataset<
        InferIntersectOutput<TOptions$1>,
        IntersectIssue | InferIssue<TOptions$1[number]>,
    >,
>

`Readonly` `Internal`~standard

`Optional` `Readonly` `Internal`~types

`Readonly`async

`Readonly`expects

`Readonly`kind

`Readonly`message

`Readonly`options

`Readonly`reference

Type Declaration

Type Parameters

Parameters

Returns IntersectSchema<TOptions$1, undefined>

Type Parameters

Parameters

Returns IntersectSchema<TOptions$1, TMessage>

Type Parameters

Parameters

Returns IntersectSchemaAsync<TOptions$1, undefined>

Type Parameters

Parameters

Returns IntersectSchemaAsync<TOptions$1, TMessage>

`Readonly`type

Settings

On This Page

Interface IntersectSchemaAsync<TOptions$1, TMessage>

Type Parameters

Hierarchy (View Summary)

Index

Properties

Properties

Readonly Internal~run

Type Declaration

Parameters

Returns Promise< OutputDataset< InferIntersectOutput<TOptions$1>, IntersectIssue | InferIssue<TOptions$1[number]>, >,>

Readonly Internal~standard

Optional Readonly Internal~types

Readonlyasync

Readonlyexpects

Readonlykind

Readonlymessage

Readonlyoptions

Readonlyreference

Type Declaration

Type Parameters

Parameters

Returns IntersectSchema<TOptions$1, undefined>

Type Parameters

Parameters

Returns IntersectSchema<TOptions$1, TMessage>

Type Parameters

Parameters

Returns IntersectSchemaAsync<TOptions$1, undefined>

Type Parameters

Parameters

Returns IntersectSchemaAsync<TOptions$1, TMessage>

Readonlytype

Settings

On This Page

`Readonly` `Internal`~run

Returns Promise<
OutputDataset<
InferIntersectOutput<TOptions$1>,
IntersectIssue | InferIssue<TOptions$1[number]>,
>,
>

`Readonly` `Internal`~standard

`Optional` `Readonly` `Internal`~types

`Readonly`async

`Readonly`expects

`Readonly`kind

`Readonly`message

`Readonly`options

`Readonly`reference

`Readonly`type