Interface ObjectSchema<TEntries, TMessage>

Object schema interface.

interface ObjectSchema<
    TEntries extends ObjectEntries,
    TMessage extends ErrorMessage<ObjectIssue> | undefined,
> {
    "~run": (
        dataset: UnknownDataset,
        config: Config<BaseIssue<unknown>>,
    ) => OutputDataset<
        {
            [TKey in string
            | number
            | symbol]: OutputWithReadonly<
                TEntries,
                OutputWithQuestionMarks<TEntries, InferEntriesOutput<TEntries>>,
            >[TKey]
        },
        ObjectIssue
        | InferObjectIssue<TEntries>,
    >;
    "~standard": StandardProps<
        {
            [TKey in string
            | number
            | symbol]: InputWithQuestionMarks<TEntries, InferEntriesInput<TEntries>>[TKey]
        },
        {
            [TKey in string
            | number
            | symbol]: OutputWithReadonly<
                TEntries,
                OutputWithQuestionMarks<TEntries, InferEntriesOutput<TEntries>>,
            >[TKey]
        },
    >;
    "~types"?: {
        input: {
            [TKey in string
            | number
            | symbol]: InputWithQuestionMarks<TEntries, InferEntriesInput<TEntries>>[TKey]
        };
        issue: ObjectIssue
        | InferObjectIssue<TEntries>;
        output: {
            [TKey in string | number | symbol]: OutputWithReadonly<
                TEntries,
                OutputWithQuestionMarks<TEntries, InferEntriesOutput<TEntries>>,
            >[TKey]
        };
    };
    async: false;
    entries: TEntries;
    expects: "Object";
    kind: "schema";
    message: TMessage;
    reference: {
        <const TEntries extends ObjectEntries>(
            entries: TEntries,
        ): ObjectSchema<TEntries, undefined>;
        <
            const TEntries extends ObjectEntries,
            const TMessage extends undefined | ErrorMessage<ObjectIssue>,
        >(
            entries: TEntries,
            message: TMessage,
        ): ObjectSchema<TEntries, TMessage>;
    };
    type: "object";
}

Type Parameters

TEntries extends ObjectEntries
TMessage extends ErrorMessage<ObjectIssue> | undefined

Hierarchy (View Summary)

BaseSchema<
    InferObjectInput<TEntries>,
    InferObjectOutput<TEntries>,
    ObjectIssue | InferObjectIssue<TEntries>,
>
- ObjectSchema

Index

Properties

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

Properties

`Readonly` `Internal`~run

"~run": (
    dataset: UnknownDataset,
    config: Config<BaseIssue<unknown>>,
) => OutputDataset<
    {
        [TKey in string
        | number
        | symbol]: OutputWithReadonly<
            TEntries,
            OutputWithQuestionMarks<TEntries, InferEntriesOutput<TEntries>>,
        >[TKey]
    },
    ObjectIssue
    | InferObjectIssue<TEntries>,
>

Parses unknown input values.

Type declaration

- (
      dataset: UnknownDataset,
      config: Config<BaseIssue<unknown>>,
  ): OutputDataset<
      {
          [TKey in string
          | number
          | symbol]: OutputWithReadonly<
              TEntries,
              OutputWithQuestionMarks<TEntries, InferEntriesOutput<TEntries>>,
          >[TKey]
      },
      ObjectIssue
      | InferObjectIssue<TEntries>,
  >
- Parameters
  - dataset: UnknownDataset
    The input dataset.
  - config: Config<BaseIssue<unknown>>
    The configuration.
  Returns OutputDataset<
      {
          [TKey in string
          | number
          | symbol]: OutputWithReadonly<
              TEntries,
              OutputWithQuestionMarks<TEntries, InferEntriesOutput<TEntries>>,
          >[TKey]
      },
      ObjectIssue
      | InferObjectIssue<TEntries>,
  >
  The output dataset.

`Readonly` `Internal`~standard

"~standard": StandardProps<
    {
        [TKey in string
        | number
        | symbol]: InputWithQuestionMarks<TEntries, InferEntriesInput<TEntries>>[TKey]
    },
    {
        [TKey in string
        | number
        | symbol]: OutputWithReadonly<
            TEntries,
            OutputWithQuestionMarks<TEntries, InferEntriesOutput<TEntries>>,
        >[TKey]
    },
>

The Standard Schema properties.

`Optional` `Readonly` `Internal`~types

"~types"?: {
    input: {
        [TKey in string | number | symbol]: InputWithQuestionMarks<
            TEntries,
            InferEntriesInput<TEntries>,
        >[TKey]
    };
    issue: ObjectIssue
    | InferObjectIssue<TEntries>;
    output: {
        [TKey in string | number | symbol]: OutputWithReadonly<
            TEntries,
            OutputWithQuestionMarks<TEntries, InferEntriesOutput<TEntries>>,
        >[TKey]
    };
}

The input, output and issue type.

`Readonly`async

async: false

Whether it's async.

`Readonly`entries

entries: TEntries

The entries schema.

`Readonly`expects

expects: "Object"

The expected property.

`Readonly`kind

kind: "schema"

The object kind.

`Readonly`message

message: TMessage

The error message.

`Readonly`reference

reference: {
    <const TEntries extends ObjectEntries>(
        entries: TEntries,
    ): ObjectSchema<TEntries, undefined>;
    <
        const TEntries extends ObjectEntries,
        const TMessage extends undefined | ErrorMessage<ObjectIssue>,
    >(
        entries: TEntries,
        message: TMessage,
    ): ObjectSchema<TEntries, TMessage>;
}

The schema reference.

Type declaration

- <const TEntries extends ObjectEntries>(
  entries: TEntries,
  ): ObjectSchema<TEntries, undefined>
- Creates an object schema.
  
  Hint: This schema removes unknown entries. The output will only include the entries you specify. To include unknown entries, use looseObject. To return an issue for unknown entries, use strictObject. To include and validate unknown entries, use objectWithRest.
  Type Parameters
  - const TEntries extends ObjectEntries
  Parameters
  - entries: TEntries
    The entries schema.
  Returns ObjectSchema<TEntries, undefined>
  An object schema.
- <
      const TEntries extends ObjectEntries,
      const TMessage extends undefined | ErrorMessage<ObjectIssue>,
  >(
      entries: TEntries,
      message: TMessage,
  ): ObjectSchema<TEntries, TMessage>
- Creates an object schema.
  
  Hint: This schema removes unknown entries. The output will only include the entries you specify. To include unknown entries, use looseObject. To return an issue for unknown entries, use strictObject. To include and validate unknown entries, use objectWithRest.
  Type Parameters
  - const TEntries extends ObjectEntries
  - const TMessage extends undefined | ErrorMessage<ObjectIssue>
  Parameters
  - entries: TEntries
    The entries schema.
  - message: TMessage
    The error message.
  Returns ObjectSchema<TEntries, TMessage>
  An object schema.

`Readonly`type

type: "object"

The schema type.

Interface ObjectSchema<TEntries, TMessage>

Type Parameters

Hierarchy (View Summary)

Index

Properties

Properties

`Readonly` `Internal`~run

Type declaration

Parameters

Returns OutputDataset<
    {
        [TKey in string
        | number
        | symbol]: OutputWithReadonly<
            TEntries,
            OutputWithQuestionMarks<TEntries, InferEntriesOutput<TEntries>>,
        >[TKey]
    },
    ObjectIssue
    | InferObjectIssue<TEntries>,
>

`Readonly` `Internal`~standard

`Optional` `Readonly` `Internal`~types

`Readonly`async

`Readonly`entries

`Readonly`expects

`Readonly`kind

`Readonly`message

`Readonly`reference

Type declaration

Type Parameters

Parameters

Returns ObjectSchema<TEntries, undefined>

Type Parameters

Parameters

Returns ObjectSchema<TEntries, TMessage>

`Readonly`type

Settings

On This Page

Interface ObjectSchema<TEntries, TMessage>

Type Parameters

Hierarchy (View Summary)

Index

Properties

Properties

Readonly Internal~run

Type declaration

Parameters

Returns OutputDataset< { [TKey in string | number | symbol]: OutputWithReadonly< TEntries, OutputWithQuestionMarks<TEntries, InferEntriesOutput<TEntries>>, >[TKey] }, ObjectIssue | InferObjectIssue<TEntries>,>

Readonly Internal~standard

Optional Readonly Internal~types

Readonlyasync

Readonlyentries

Readonlyexpects

Readonlykind

Readonlymessage

Readonlyreference

Type declaration

Type Parameters

Parameters

Returns ObjectSchema<TEntries, undefined>

Type Parameters

Parameters

Returns ObjectSchema<TEntries, TMessage>

Readonlytype

Settings

On This Page

`Readonly` `Internal`~run

Returns OutputDataset<
{
[TKey in string
| number
| symbol]: OutputWithReadonly<
TEntries,
OutputWithQuestionMarks<TEntries, InferEntriesOutput<TEntries>>,
>[TKey]
},
ObjectIssue
| InferObjectIssue<TEntries>,
>

`Readonly` `Internal`~standard

`Optional` `Readonly` `Internal`~types

`Readonly`async

`Readonly`entries

`Readonly`expects

`Readonly`kind

`Readonly`message

`Readonly`reference

`Readonly`type