Interface StringSchema<TMessage>

String schema interface.

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

Type Parameters

TMessage extends ErrorMessage<StringIssue> | undefined

Hierarchy (View Summary)

BaseSchema<string, string, StringIssue>
- StringSchema

Index

Properties

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

Properties

`Readonly` `Internal`~run

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

Parses unknown input values.

Type declaration

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

`Readonly` `Internal`~standard

"~standard": StandardProps<string, string>

The Standard Schema properties.

`Optional` `Readonly` `Internal`~types

"~types"?: { input: string; issue: StringIssue; output: string }

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`message

message: TMessage

The error message.

`Readonly`reference

reference: {
    (): StringSchema<undefined>;
    <const TMessage extends undefined | ErrorMessage<StringIssue>>(
        message: TMessage,
    ): StringSchema<TMessage>;
}

The schema reference.

Type declaration

- (): StringSchema<undefined>
- Creates a string schema.
  
  Returns StringSchema<undefined>
  A string schema.
- <const TMessage extends undefined | ErrorMessage<StringIssue>>(
  message: TMessage,
  ): StringSchema<TMessage>
- Creates a string schema.
  Type Parameters
  - const TMessage extends undefined | ErrorMessage<StringIssue>
  Parameters
  - message: TMessage
    The error message.
  Returns StringSchema<TMessage>
  A string schema.

`Readonly`type

type: "string"

The schema type.