Interface LiteralSchema<TLiteral, TMessage>

Literal schema interface.

interface LiteralSchema<
    TLiteral extends Literal,
    TMessage extends ErrorMessage<LiteralIssue> | undefined,
> {
    "~run": (
        dataset: UnknownDataset,
        config: Config<BaseIssue<unknown>>,
    ) => OutputDataset<TLiteral, LiteralIssue>;
    "~standard": StandardProps<TLiteral, TLiteral>;
    "~types"?: { input: TLiteral; issue: LiteralIssue; output: TLiteral };
    async: false;
    expects: string;
    kind: "schema";
    literal: TLiteral;
    message: TMessage;
    reference: {
        <const TLiteral extends Literal>(
            literal_: TLiteral,
        ): LiteralSchema<TLiteral, undefined>;
        <
            const TLiteral extends Literal,
            const TMessage extends undefined | ErrorMessage<LiteralIssue>,
        >(
            literal_: TLiteral,
            message: TMessage,
        ): LiteralSchema<TLiteral, TMessage>;
    };
    type: "literal";
}

Type Parameters

TLiteral extends Literal
TMessage extends ErrorMessage<LiteralIssue> | undefined

Hierarchy (View Summary)

BaseSchema<TLiteral, TLiteral, LiteralIssue>
- LiteralSchema

Index

Properties

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

Properties

`Readonly` `Internal`~run

"~run": (
dataset: UnknownDataset,
config: Config<BaseIssue<unknown>>,
) => OutputDataset<TLiteral, LiteralIssue>

Parses unknown input values.

Type declaration

- (
  dataset: UnknownDataset,
  config: Config<BaseIssue<unknown>>,
  ): OutputDataset<TLiteral, LiteralIssue>
- Parameters
  - dataset: UnknownDataset
    The input dataset.
  - config: Config<BaseIssue<unknown>>
    The configuration.
  Returns OutputDataset<TLiteral, LiteralIssue>
  The output dataset.

`Readonly` `Internal`~standard

"~standard": StandardProps<TLiteral, TLiteral>

The Standard Schema properties.

`Optional` `Readonly` `Internal`~types

"~types"?: { input: TLiteral; issue: LiteralIssue; output: TLiteral }

The input, output and issue type.

`Readonly`async

async: false

Whether it's async.

`Readonly`expects

expects: string

The expected property.

`Readonly`kind

kind: "schema"

The object kind.

`Readonly`literal

literal: TLiteral

The literal value.

`Readonly`message

message: TMessage

The error message.

`Readonly`reference

reference: {
    <const TLiteral extends Literal>(
        literal_: TLiteral,
    ): LiteralSchema<TLiteral, undefined>;
    <
        const TLiteral extends Literal,
        const TMessage extends undefined | ErrorMessage<LiteralIssue>,
    >(
        literal_: TLiteral,
        message: TMessage,
    ): LiteralSchema<TLiteral, TMessage>;
}

The schema reference.

Type declaration

- <const TLiteral extends Literal>(
  literal_: TLiteral,
  ): LiteralSchema<TLiteral, undefined>
- Creates a literal schema.
  Type Parameters
  - const TLiteral extends Literal
  Parameters
  - literal_: TLiteral
    The literal value.
  Returns LiteralSchema<TLiteral, undefined>
  A literal schema.
- <
      const TLiteral extends Literal,
      const TMessage extends undefined | ErrorMessage<LiteralIssue>,
  >(
      literal_: TLiteral,
      message: TMessage,
  ): LiteralSchema<TLiteral, TMessage>
- Creates a literal schema.
  Type Parameters
  - const TLiteral extends Literal
  - const TMessage extends undefined | ErrorMessage<LiteralIssue>
  Parameters
  - literal_: TLiteral
    The literal value.
  - message: TMessage
    The error message.
  Returns LiteralSchema<TLiteral, TMessage>
  A literal schema.

`Readonly`type

type: "literal"

The schema type.