Class ArrayShape<HeadShapes, RestShape>

The shape of an array or a tuple value.

Shape	Input Type	Output Type
`ArrayShape<[], null>`	`[]`	`[]`
`ArrayShape<[], Shape<A, B>>`	`A[]`	`B[]`
`ArrayShape<[Shape<A, B>, Shape<X, Y>], null>`	`[A, X]`	`[B, Y]`
`ArrayShape<[Shape<A, B>], Shape<X, Y>>`	`[A, ...X[]]`	`[B, ...Y[]]`

Type Parameters

HeadShapes extends readonly AnyShape[]
The array of positioned element shapes.
RestShape extends AnyShape | null
The shape of rest elements, or null if there are no rest elements.

Hierarchy (View Summary)

Shape<
InferArray<HeadShapes, RestShape, INPUT>,
InferArray<HeadShapes, RestShape, OUTPUT>,
>
- ArrayShape

Implements

DeepPartialProtocol<DeepPartialArrayShape<HeadShapes, RestShape>>

Constructors

constructor

new ArrayShape<
    HeadShapes extends readonly AnyShape[],
    RestShape extends null | AnyShape,
>(
    headShapes: HeadShapes,
    restShape: RestShape,
    options?: IssueOptions | Message,
): ArrayShape<HeadShapes, RestShape>
Creates a new ArrayShape instance.
Type Parameters
- HeadShapes extends readonly AnyShape[]
  The array of positioned element shapes.
- RestShape extends null | AnyShape
  The shape of rest elements, or null if there are no rest elements.
Parameters
- headShapes: HeadShapes
  The array of positioned element shapes.
- restShape: RestShape
  The shape of rest elements or null if there are no rest elements.
- Optionaloptions: IssueOptions | Message
  The issue options or the issue message.
Returns ArrayShape<HeadShapes, RestShape>
Overrides Shape.constructor

Properties

`Protected`_options

_options: undefined | IssueOptions | Message

The type issue options or the type issue message.

annotations

annotations: Dict = {}

The dictionary of shape annotations.

See

Shape.annotate

`Readonly`headShapes

headShapes: HeadShapes

The array of positioned element shapes.

`Readonly`inputs

inputs: readonly unknown[]

The array of unique input types and values that are accepted by the shape.

`Readonly`isAsync

isAsync: boolean

true if the shape allows only Shape.parseAsync and throws an error if Shape.parse is called, or false if the shape can be used in both sync and async contexts.

isCoercing

isCoercing: boolean = false

true if this shape coerces input values to the required type during parsing, or false otherwise.

operations

operations: readonly Operation[] = []

The array of operations that are applied to the shape output.

See

`Readonly`restShape

restShape: RestShape

The shape of rest elements or null if there are no rest elements.

Methods

`Protected`_apply

_apply(
    input: any,
    options: ParseOptions,
    nonce: number,
): Result<
    [
        ...{ [K in string
        | number
        | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
        ...(
            RestShape extends undefined
            | null
                ? []
                : RestShape extends Shape<any, any>
                    ? RestShape<RestShape>[typeof OUTPUT][]
                    : []
        )[],
    ],
>
Synchronously parses the input.
Parameters
- input: any
  The shape input to parse.
- options: ParseOptions
  Parsing options.
- nonce: number
Returns Result<
    [
        ...{ [K in string
        | number
        | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
        ...(
            RestShape extends undefined
            | null
                ? []
                : RestShape extends Shape<any, any>
                    ? RestShape<RestShape>[typeof OUTPUT][]
                    : []
        )[],
    ],
>
null if input matches the output, Ok that wraps the output, or an array of captured issues.

See
Advanced shapes

Overrides Shape._apply

`Protected`_applyAsync

_applyAsync(
    input: any,
    options: ParseOptions,
    nonce: number,
): Promise<
    Result<
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
    >,
>
Asynchronously parses the input.
Parameters
- input: any
  The shape input to parse.
- options: ParseOptions
  Parsing options.
- nonce: number
  The globally unique number that identifies the parsing process.
Returns Promise<
    Result<
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
    >,
>
null if input matches the output, Ok that wraps the output, or an array of captured issues.

See
Advanced shapes

Overrides Shape._applyAsync

`Protected`_applyOperations

_applyOperations(
    input: unknown,
    output: unknown,
    options: ParseOptions,
    issues: null | Issue[],
): Result | Promise<Result>
The callback that applies Shape.operations to the shape output value.

This method returns a promise if there are async Shape.operations.

If the shape overrides only Shape._apply and doesn't override Shape._applyAsync then it's only safe to call this method as the last statement in Shape._apply. Otherwise, it may return an unexpected promise.

If the shape overrides both Shape._apply and Shape._applyAsync then this method would always synchronously return a Result inside Shape._apply.
Parameters
- input: unknown
- output: unknown
- options: ParseOptions
- issues: null | Issue[]
Returns Result | Promise<Result>
Inherited from Shape._applyOperations

`Protected`_clone

_clone(): this
Clones the shape.

Returns this
See
Advanced shapes

Inherited from Shape._clone

`Protected`_getInputs

_getInputs(): readonly unknown[]
Returns input types and literal values that this shape can accept as an input.

Returns readonly unknown[]
See
Advanced shapes

Overrides Shape._getInputs

`Protected`_isAsync

_isAsync(): boolean
Must return true if the shape must be used in async context only, otherwise the shape can be used in both sync and async contexts. Override this method to implement a custom shape.

Returns boolean
See
Advanced shapes

Overrides Shape._isAsync

accepts

accepts(input: unknown): boolean
Returns true if the shape accepts given input type or value, or false otherwise.
Parameters
- input: unknown
  The type or value that must be checked.
Returns boolean
Inherited from Shape.accepts

addAsyncOperation

addAsyncOperation<Param>(
    cb: OperationCallback<
        PromiseLike<
            Result<
                [
                    ...{
                        [K in string
                        | number
                        | symbol]: HeadShapes[K<K>][typeof OUTPUT]
                    }[],
                    ...(
                        RestShape extends undefined
                        | null
                            ? []
                            : RestShape extends Shape<any, any>
                                ? RestShape<RestShape>[typeof OUTPUT][]
                                : []
                    )[],
                ],
            >,
        >,
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
        Param,
    >,
    options?: ParameterizedOperationOptions<Param>,
): this
Adds an asynchronous operation to the shape.
Type Parameters
- Param
  The param that is passed to the operation when it is applied.
Parameters
- cb: OperationCallback<
      PromiseLike<
          Result<
              [
                  ...{
                      [K in string
                      | number
                      | symbol]: HeadShapes[K<K>][typeof OUTPUT]
                  }[],
                  ...(
                      RestShape extends undefined
                      | null
                          ? []
                          : RestShape extends Shape<any, any>
                              ? RestShape<RestShape>[typeof OUTPUT][]
                              : []
                  )[],
              ],
          >,
      >,
      [
          ...{ [K in string
          | number
          | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
          ...(
              RestShape extends undefined
              | null
                  ? []
                  : RestShape extends Shape<any, any>
                      ? RestShape<RestShape>[typeof OUTPUT][]
                      : []
          )[],
      ],
      Param,
  >
  The callback that asynchronously applies an operation to the shape output value.
- Optionaloptions: ParameterizedOperationOptions<Param>
  The operation options.
Returns this
The clone of the shape.

See
Operations

Inherited from Shape.addAsyncOperation
addAsyncOperation(
    cb: OperationCallback<
        PromiseLike<
            Result<
                [
                    ...{
                        [K in string
                        | number
                        | symbol]: HeadShapes[K<K>][typeof OUTPUT]
                    }[],
                    ...(
                        RestShape extends undefined
                        | null
                            ? []
                            : RestShape extends Shape<any, any>
                                ? RestShape<RestShape>[typeof OUTPUT][]
                                : []
                    )[],
                ],
            >,
        >,
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
    >,
    options?: OperationOptions,
): this
Adds an asynchronous operation to the shape.
Parameters
- cb: OperationCallback<
      PromiseLike<
          Result<
              [
                  ...{
                      [K in string
                      | number
                      | symbol]: HeadShapes[K<K>][typeof OUTPUT]
                  }[],
                  ...(
                      RestShape extends undefined
                      | null
                          ? []
                          : RestShape extends Shape<any, any>
                              ? RestShape<RestShape>[typeof OUTPUT][]
                              : []
                  )[],
              ],
          >,
      >,
      [
          ...{ [K in string
          | number
          | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
          ...(
              RestShape extends undefined
              | null
                  ? []
                  : RestShape extends Shape<any, any>
                      ? RestShape<RestShape>[typeof OUTPUT][]
                      : []
          )[],
      ],
  >
  The callback that asynchronously applies an operation to the shape output value.
- Optionaloptions: OperationOptions
  The operation options.
Returns this
The clone of the shape.

See
Operations

Inherited from Shape.addAsyncOperation

addOperation

addOperation<Param>(
    cb: OperationCallback<
        Result<
            [
                ...{
                    [K in string
                    | number
                    | symbol]: HeadShapes[K<K>][typeof OUTPUT]
                }[],
                ...(
                    RestShape extends undefined
                    | null
                        ? []
                        : RestShape extends Shape<any, any>
                            ? RestShape<RestShape>[typeof OUTPUT][]
                            : []
                )[],
            ],
        >,
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
        Param,
    >,
    options?: ParameterizedOperationOptions<Param>,
): this
Adds a synchronous operation to the shape.
Type Parameters
- Param
  The param that is passed to the operation when it is applied.
Parameters
- cb: OperationCallback<
      Result<
          [
              ...{
                  [K in string
                  | number
                  | symbol]: HeadShapes[K<K>][typeof OUTPUT]
              }[],
              ...(
                  RestShape extends undefined
                  | null
                      ? []
                      : RestShape extends Shape<any, any>
                          ? RestShape<RestShape>[typeof OUTPUT][]
                          : []
              )[],
          ],
      >,
      [
          ...{ [K in string
          | number
          | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
          ...(
              RestShape extends undefined
              | null
                  ? []
                  : RestShape extends Shape<any, any>
                      ? RestShape<RestShape>[typeof OUTPUT][]
                      : []
          )[],
      ],
      Param,
  >
  The callback that synchronously applies an operation to the shape output value.
- Optionaloptions: ParameterizedOperationOptions<Param>
  The operation options.
Returns this
The clone of the shape.

See
Operations

Inherited from Shape.addOperation
addOperation(
    cb: OperationCallback<
        Result<
            [
                ...{
                    [K in string
                    | number
                    | symbol]: HeadShapes[K<K>][typeof OUTPUT]
                }[],
                ...(
                    RestShape extends undefined
                    | null
                        ? []
                        : RestShape extends Shape<any, any>
                            ? RestShape<RestShape>[typeof OUTPUT][]
                            : []
                )[],
            ],
        >,
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
    >,
    options?: OperationOptions,
): this
Adds a synchronous operation to the shape.
Parameters
- cb: OperationCallback<
      Result<
          [
              ...{
                  [K in string
                  | number
                  | symbol]: HeadShapes[K<K>][typeof OUTPUT]
              }[],
              ...(
                  RestShape extends undefined
                  | null
                      ? []
                      : RestShape extends Shape<any, any>
                          ? RestShape<RestShape>[typeof OUTPUT][]
                          : []
              )[],
          ],
      >,
      [
          ...{ [K in string
          | number
          | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
          ...(
              RestShape extends undefined
              | null
                  ? []
                  : RestShape extends Shape<any, any>
                      ? RestShape<RestShape>[typeof OUTPUT][]
                      : []
          )[],
      ],
  >
  The callback that synchronously applies an operation to the shape output value.
- Optionaloptions: OperationOptions
  The operation options.
Returns this
The clone of the shape.

See
Operations

Inherited from Shape.addOperation

allow

allow<AllowedValue extends Any>(
value: AllowedValue,
): AllowShape<ArrayShape<HeadShapes, RestShape>, AllowedValue>
Allows an input value, so it is passed directly to the output.
Type Parameters
- AllowedValue extends Any
  The allowed value.
Parameters
- value: AllowedValue
  The allowed value.
Returns AllowShape<ArrayShape<HeadShapes, RestShape>, AllowedValue>
Inherited from Shape.allow

alter

alter<Param>(
    cb: OperationCallback<
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
        Param,
    >,
    options: ParameterizedOperationOptions<Param>,
): this
Adds a synchronous operation that alters the output value without changing its type.

If you want to change the base type, consider using Shape.convert.
Type Parameters
- Param
  The param that is passed to the operation when it is applied.
Parameters
- cb: OperationCallback<
      [
          ...{ [K in string
          | number
          | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
          ...(
              RestShape extends undefined
              | null
                  ? []
                  : RestShape extends Shape<any, any>
                      ? RestShape<RestShape>[typeof OUTPUT][]
                      : []
          )[],
      ],
      [
          ...{ [K in string
          | number
          | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
          ...(
              RestShape extends undefined
              | null
                  ? []
                  : RestShape extends Shape<any, any>
                      ? RestShape<RestShape>[typeof OUTPUT][]
                      : []
          )[],
      ],
      Param,
  >
  The callback that alters the shape output. Throw a ValidationError to notify that the alteration cannot be successfully completed.
- options: ParameterizedOperationOptions<Param>
  The operation options.
Returns this
The clone of the shape.
See
Inherited from Shape.alter
alter(
    cb: OperationCallback<
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
    >,
    options?: OperationOptions,
): this
Adds a synchronous operation that alters the output value without changing its type.

If you want to change the base type, consider using Shape.convert.
Parameters
- cb: OperationCallback<
      [
          ...{ [K in string
          | number
          | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
          ...(
              RestShape extends undefined
              | null
                  ? []
                  : RestShape extends Shape<any, any>
                      ? RestShape<RestShape>[typeof OUTPUT][]
                      : []
          )[],
      ],
      [
          ...{ [K in string
          | number
          | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
          ...(
              RestShape extends undefined
              | null
                  ? []
                  : RestShape extends Shape<any, any>
                      ? RestShape<RestShape>[typeof OUTPUT][]
                      : []
          )[],
      ],
  >
  The callback that alters the shape output. Throw a ValidationError to notify that the alteration cannot be successfully completed.
- Optionaloptions: OperationOptions
  The operation options.
Returns this
The clone of the shape.
See
Inherited from Shape.alter

alterAsync

alterAsync<Param>(
    cb: OperationCallback<
        PromiseLike<
            [
                ...{
                    [K in string
                    | number
                    | symbol]: HeadShapes[K<K>][typeof OUTPUT]
                }[],
                ...(
                    RestShape extends undefined
                    | null
                        ? []
                        : RestShape extends Shape<any, any>
                            ? RestShape<RestShape>[typeof OUTPUT][]
                            : []
                )[],
            ],
        >,
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
        Param,
    >,
    options: ParameterizedOperationOptions<Param>,
): this
Adds an asynchronous operation that alters the output value without changing its type.

If you want to change the base type, consider using Shape.convertAsync.
Type Parameters
- Param
  The param that is passed to the operation when it is applied.
Parameters
- cb: OperationCallback<
      PromiseLike<
          [
              ...{
                  [K in string
                  | number
                  | symbol]: HeadShapes[K<K>][typeof OUTPUT]
              }[],
              ...(
                  RestShape extends undefined
                  | null
                      ? []
                      : RestShape extends Shape<any, any>
                          ? RestShape<RestShape>[typeof OUTPUT][]
                          : []
              )[],
          ],
      >,
      [
          ...{ [K in string
          | number
          | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
          ...(
              RestShape extends undefined
              | null
                  ? []
                  : RestShape extends Shape<any, any>
                      ? RestShape<RestShape>[typeof OUTPUT][]
                      : []
          )[],
      ],
      Param,
  >
  The callback that alters the shape output. Throw a ValidationError to notify that the alteration cannot be successfully completed.
- options: ParameterizedOperationOptions<Param>
  The operation options.
Returns this
The clone of the shape.
See
Inherited from Shape.alterAsync
alterAsync(
    cb: OperationCallback<
        PromiseLike<
            [
                ...{
                    [K in string
                    | number
                    | symbol]: HeadShapes[K<K>][typeof OUTPUT]
                }[],
                ...(
                    RestShape extends undefined
                    | null
                        ? []
                        : RestShape extends Shape<any, any>
                            ? RestShape<RestShape>[typeof OUTPUT][]
                            : []
                )[],
            ],
        >,
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
    >,
    options?: OperationOptions,
): this
Adds an asynchronous operation that alters the output value without changing its type.

If you want to change the base type, consider using Shape.convertAsync.
Parameters
- cb: OperationCallback<
      PromiseLike<
          [
              ...{
                  [K in string
                  | number
                  | symbol]: HeadShapes[K<K>][typeof OUTPUT]
              }[],
              ...(
                  RestShape extends undefined
                  | null
                      ? []
                      : RestShape extends Shape<any, any>
                          ? RestShape<RestShape>[typeof OUTPUT][]
                          : []
              )[],
          ],
      >,
      [
          ...{ [K in string
          | number
          | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
          ...(
              RestShape extends undefined
              | null
                  ? []
                  : RestShape extends Shape<any, any>
                      ? RestShape<RestShape>[typeof OUTPUT][]
                      : []
          )[],
      ],
  >
  The callback that alters the shape output. Throw a ValidationError to notify that the alteration cannot be successfully completed.
- Optionaloptions: OperationOptions
  The operation options.
Returns this
The clone of the shape.
See
Inherited from Shape.alterAsync

annotate

annotate(annotations: ReadonlyDict): this
Adds annotations to the shape.
Parameters
- annotations: ReadonlyDict
  Annotations to add.
Returns this
The clone of the shape with the updated annotations.

See
Shape.annotations

Inherited from Shape.annotate

at

at(key: unknown): null | AnyShape
Returns a sub-shape that describes a value associated with the given property name, or null if there's no such sub-shape.
Parameters
- key: unknown
Returns null | AnyShape
The sub-shape or null if there's no such key in the shape.

Overrides Shape.at

brand

brand<Brand extends string | number | symbol>(): RefineShape<
    ArrayShape<HeadShapes, RestShape>,
    Branded<
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
        Brand,
    >,
>
Returns a shape that adds a brand to the output type.
Type Parameters
- Brand extends string | number | symbol
  The brand value.
Returns RefineShape<
    ArrayShape<HeadShapes, RestShape>,
    Branded<
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
        Brand,
    >,
>
A shape with the branded output type.

Inherited from Shape.brand

catch

catch(): CatchShape<ArrayShape<HeadShapes, RestShape>, undefined>
Returns undefined if parsing fails.

Returns CatchShape<ArrayShape<HeadShapes, RestShape>, undefined>
Inherited from Shape.catch
catch<FallbackValue extends Any>(
    fallback:
        | FallbackValue
        | ((input: any, issues: Issue[], options: ParseOptions) => FallbackValue),
): CatchShape<ArrayShape<HeadShapes, RestShape>, FallbackValue>
Returns the fallback value if parsing fails.
Type Parameters
- FallbackValue extends Any
  The fallback value.
Parameters
- fallback:
  | FallbackValue
  | ((input: any, issues: Issue[], options: ParseOptions) => FallbackValue)
  The value or a callback that returns a value that is returned if parsing has failed. A callback receives an input value, an array of raised issues, and parsing options.
Returns CatchShape<ArrayShape<HeadShapes, RestShape>, FallbackValue>
Inherited from Shape.catch

check

check<Param>(
    cb: OperationCallback<
        CheckResult,
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
        Param,
    >,
    options: ParameterizedOperationOptions<Param>,
): this
Adds a synchronous operation that checks that the shape output satisfies a requirement.

The callback must return null or undefined if value is valid, or an issue or an array of issues if value is invalid. If a callback returns an empty array, it is considered that no issues have occurred.
Type Parameters
- Param
  The param that is passed to the operation when it is applied.
Parameters
- cb: OperationCallback<
      CheckResult,
      [
          ...{ [K in string
          | number
          | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
          ...(
              RestShape extends undefined
              | null
                  ? []
                  : RestShape extends Shape<any, any>
                      ? RestShape<RestShape>[typeof OUTPUT][]
                      : []
          )[],
      ],
      Param,
  >
  The callback that checks that a value satisfies a requirement and returns issues if it doesn't.
- options: ParameterizedOperationOptions<Param>
  The operation options.
Returns this
The clone of the shape.
See
Inherited from Shape.check
check(
    cb: OperationCallback<
        CheckResult,
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
    >,
    options?: OperationOptions,
): this
Adds a synchronous operation that checks that the shape output satisfies a requirement.

The callback must return null or undefined if value is valid, or an issue or an array of issues if value is invalid. If a callback returns an empty array, it is considered that no issues have occurred.
Parameters
- cb: OperationCallback<
      CheckResult,
      [
          ...{ [K in string
          | number
          | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
          ...(
              RestShape extends undefined
              | null
                  ? []
                  : RestShape extends Shape<any, any>
                      ? RestShape<RestShape>[typeof OUTPUT][]
                      : []
          )[],
      ],
  >
  The callback that checks that a value satisfies a requirement and returns issues if it doesn't.
- Optionaloptions: OperationOptions
  The operation options.
Returns this
The clone of the shape.
See
Inherited from Shape.check

checkAsync

checkAsync<Param>(
    cb: OperationCallback<
        PromiseLike<CheckResult>,
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
        Param,
    >,
    options: ParameterizedOperationOptions<Param>,
): this
Adds an asynchronous operation that checks that the shape output satisfies a requirement.

The callback must return a promise that is resolved with null or undefined if value is valid, or an issue or an array of issues if value is invalid. If promise resolves with an empty array, it is considered that no issues have occurred.
Type Parameters
- Param
  The param that is passed to the operation when it is applied.
Parameters
- cb: OperationCallback<
      PromiseLike<CheckResult>,
      [
          ...{ [K in string
          | number
          | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
          ...(
              RestShape extends undefined
              | null
                  ? []
                  : RestShape extends Shape<any, any>
                      ? RestShape<RestShape>[typeof OUTPUT][]
                      : []
          )[],
      ],
      Param,
  >
  The callback that checks that a value satisfies a requirement and returns issues if it doesn't.
- options: ParameterizedOperationOptions<Param>
  The operation options.
Returns this
The clone of the shape.
See
Inherited from Shape.checkAsync
checkAsync(
    cb: OperationCallback<
        PromiseLike<CheckResult>,
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
    >,
    options?: OperationOptions,
): this
Adds an asynchronous operation that checks that the shape output satisfies a requirement.

The callback must return a promise that is resolved with null or undefined if value is valid, or an issue or an array of issues if value is invalid. If promise resolves with an empty array, it is considered that no issues have occurred.
Parameters
- cb: OperationCallback<
      PromiseLike<CheckResult>,
      [
          ...{ [K in string
          | number
          | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
          ...(
              RestShape extends undefined
              | null
                  ? []
                  : RestShape extends Shape<any, any>
                      ? RestShape<RestShape>[typeof OUTPUT][]
                      : []
          )[],
      ],
  >
  The callback that checks that a value satisfies a requirement and returns issues if it doesn't.
- Optionaloptions: OperationOptions
  The operation options.
Returns this
The clone of the shape.
See
Inherited from Shape.checkAsync

coerce

coerce(): this
Enables an input value coercion.

Returns this
The clone of the shape.

convert

convert<ConvertedValue>(
    cb: (
        value: [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
        options: ParseOptions,
    ) => ConvertedValue,
): Shape<
    [
        ...{ [K in string
        | number
        | symbol]: HeadShapes[K<K>][typeof INPUT] }[],
        ...(
            RestShape extends undefined
            | null
                ? []
                : RestShape extends Shape<any, any>
                    ? RestShape<RestShape>[typeof INPUT][]
                    : []
        )[],
    ],
    ConvertedValue,
>
Synchronously converts the output value of the shape.

If you want to don't want to change the base type, consider using Shape.alter.
Type Parameters
- ConvertedValue
  The value returned from the callback that converts the output value of this shape.
Parameters
- cb: (
      value: [
          ...{ [K in string
          | number
          | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
          ...(
              RestShape extends undefined
              | null
                  ? []
                  : RestShape extends Shape<any, any>
                      ? RestShape<RestShape>[typeof OUTPUT][]
                      : []
          )[],
      ],
      options: ParseOptions,
  ) => ConvertedValue
  The callback that converts the input value. Throw a ValidationError to notify that the conversion cannot be successfully completed.
Returns Shape<
    [
        ...{ [K in string
        | number
        | symbol]: HeadShapes[K<K>][typeof INPUT] }[],
        ...(
            RestShape extends undefined
            | null
                ? []
                : RestShape extends Shape<any, any>
                    ? RestShape<RestShape>[typeof INPUT][]
                    : []
        )[],
    ],
    ConvertedValue,
>
The ConvertShape instance.
See
- Shape.convertAsync
- Shape.alter
Inherited from Shape.convert

convertAsync

convertAsync<ConvertedValue>(
    cb: (
        value: [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
        options: ParseOptions,
    ) => PromiseLike<ConvertedValue>,
): Shape<
    [
        ...{ [K in string
        | number
        | symbol]: HeadShapes[K<K>][typeof INPUT] }[],
        ...(
            RestShape extends undefined
            | null
                ? []
                : RestShape extends Shape<any, any>
                    ? RestShape<RestShape>[typeof INPUT][]
                    : []
        )[],
    ],
    ConvertedValue,
>
Asynchronously converts the output value of the shape.

If you want to don't want to change the base type, consider using Shape.alterAsync.
Type Parameters
- ConvertedValue
  The value returned from the callback that converts the output value of this shape.
Parameters
- cb: (
      value: [
          ...{ [K in string
          | number
          | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
          ...(
              RestShape extends undefined
              | null
                  ? []
                  : RestShape extends Shape<any, any>
                      ? RestShape<RestShape>[typeof OUTPUT][]
                      : []
          )[],
      ],
      options: ParseOptions,
  ) => PromiseLike<ConvertedValue>
  The callback that converts the input value asynchronously. The returned promise can be rejected with a ValidationError to notify that the conversion cannot be successfully completed.
Returns Shape<
    [
        ...{ [K in string
        | number
        | symbol]: HeadShapes[K<K>][typeof INPUT] }[],
        ...(
            RestShape extends undefined
            | null
                ? []
                : RestShape extends Shape<any, any>
                    ? RestShape<RestShape>[typeof INPUT][]
                    : []
        )[],
    ],
    ConvertedValue,
>
The ConvertShape instance.
See
- Shape.convert
- Shape.alterAsync
Inherited from Shape.convertAsync

deepPartial

deepPartial(): DeepPartialArrayShape<HeadShapes, RestShape>
Converts the shape and its child shapes to deep partial alternatives.

Note: This method returns a shape without any operations.

Returns DeepPartialArrayShape<HeadShapes, RestShape>
The deep partial clone of the shape.

Implementation of DeepPartialProtocol.deepPartial

deny

deny<
    DeniedValue extends
        | [
            ...{ [K in string
            | number
            | symbol]: HeadShapes[K<K>][typeof INPUT] }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof INPUT][]
                        : []
            )[],
        ]
        | [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
>(
    value: DeniedValue,
    options?: IssueOptions | Message,
): DenyShape<ArrayShape<HeadShapes, RestShape>, DeniedValue>
Excludes value from both input and output.
Type Parameters
- DeniedValue extends
      | [
          ...{ [K in string
          | number
          | symbol]: HeadShapes[K<K>][typeof INPUT] }[],
          ...(
              RestShape extends undefined
              | null
                  ? []
                  : RestShape extends Shape<any, any>
                      ? RestShape<RestShape>[typeof INPUT][]
                      : []
          )[],
      ]
      | [
          ...{ [K in string
          | number
          | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
          ...(
              RestShape extends undefined
              | null
                  ? []
                  : RestShape extends Shape<any, any>
                      ? RestShape<RestShape>[typeof OUTPUT][]
                      : []
          )[],
      ]
  The denied value.
Parameters
- value: DeniedValue
  The excluded value.
- Optionaloptions: IssueOptions | Message
  The issue options or the issue message.
Returns DenyShape<ArrayShape<HeadShapes, RestShape>, DeniedValue>
Inherited from Shape.deny

exclude

exclude<ExcludedShape extends AnyShape>(
shape: ExcludedShape,
options?: IssueOptions | Message,
): ExcludeShape<ArrayShape<HeadShapes, RestShape>, ExcludedShape>
Checks that the input doesn't match the shape.
Type Parameters
- ExcludedShape extends AnyShape
  The shape to which the output must not conform.
Parameters
- shape: ExcludedShape
  The shape to which the output must not conform.
- Optionaloptions: IssueOptions | Message
  The issue options or the issue message.
Returns ExcludeShape<ArrayShape<HeadShapes, RestShape>, ExcludedShape>
Inherited from Shape.exclude

nonOptional

nonOptional(
options?: IssueOptions | Message,
): DenyShape<ArrayShape<HeadShapes, RestShape>, undefined>
Prevents an input and output from being undefined.
Parameters
- Optionaloptions: IssueOptions | Message
  The issue options or the issue message.
Returns DenyShape<ArrayShape<HeadShapes, RestShape>, undefined>
Inherited from Shape.nonOptional

not

not<ExcludedShape extends AnyShape>(
shape: ExcludedShape,
options?: IssueOptions | Message,
): NotShape<ArrayShape<HeadShapes, RestShape>, ExcludedShape>
Checks that the input doesn't match the shape.

This method works exactly as Shape.exclude at runtime, but it doesn't perform the exclusion on the type level.
Type Parameters
- ExcludedShape extends AnyShape
  The shape to which the output must not conform.
Parameters
- shape: ExcludedShape
  The shape to which the output must not conform.
- Optionaloptions: IssueOptions | Message
  The issue options or the issue message.
Returns NotShape<ArrayShape<HeadShapes, RestShape>, ExcludedShape>
Inherited from Shape.not

nullable

nullable(): AllowShape<ArrayShape<HeadShapes, RestShape>, null>
Replaces null input value with an null output value.

Returns AllowShape<ArrayShape<HeadShapes, RestShape>, null>
Inherited from Shape.nullable
nullable<DefaultValue extends Any>(
defaultValue: DefaultValue,
): ReplaceShape<ArrayShape<HeadShapes, RestShape>, null, DefaultValue>
Replaces null input value with a default output value.
Type Parameters
- DefaultValue extends Any
  The value that is used as the replacement for null.
Parameters
- defaultValue: DefaultValue
  The value that should be used if an input value is null.
Returns ReplaceShape<ArrayShape<HeadShapes, RestShape>, null, DefaultValue>
Inherited from Shape.nullable

nullish

nullish(): AllowShape<
AllowShape<ArrayShape<HeadShapes, RestShape>, null>,
undefined,
>
Passes null and undefined input values directly to the output without parsing.

Returns AllowShape<AllowShape<ArrayShape<HeadShapes, RestShape>, null>, undefined>
Inherited from Shape.nullish
nullish<DefaultValue extends Any>(
    defaultValue?: DefaultValue,
): ReplaceShape<
    ReplaceShape<ArrayShape<HeadShapes, RestShape>, null, DefaultValue>,
    undefined,
    DefaultValue,
>
Replaces null and undefined input value with a default output value.
Type Parameters
- DefaultValue extends Any
  The value that is used as the replacement for undefined and null.
Parameters
- OptionaldefaultValue: DefaultValue
  The value that should be used if an input value is undefined or null.
Returns ReplaceShape<
    ReplaceShape<ArrayShape<HeadShapes, RestShape>, null, DefaultValue>,
    undefined,
    DefaultValue,
>
Inherited from Shape.nullish

optional

optional(): AllowShape<ArrayShape<HeadShapes, RestShape>, undefined>
Replaces undefined input value with an undefined output value.

Returns AllowShape<ArrayShape<HeadShapes, RestShape>, undefined>
Inherited from Shape.optional
optional<DefaultValue extends Any>(
defaultValue: DefaultValue,
): ReplaceShape<ArrayShape<HeadShapes, RestShape>, undefined, DefaultValue>
Replaces undefined input value with a default output value.
Type Parameters
- DefaultValue extends Any
  The value that is used as the replacement for undefined.
Parameters
- defaultValue: DefaultValue
  The value that should be used if an input value is undefined.
Returns ReplaceShape<ArrayShape<HeadShapes, RestShape>, undefined, DefaultValue>
Inherited from Shape.optional

parse

parse(
    input: unknown,
    options?: ParseOptions,
): [
    ...{ [K in string
    | number
    | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
    ...(
        RestShape extends undefined
        | null
            ? []
            : RestShape extends Shape<any, any>
                ? RestShape<RestShape>[typeof OUTPUT][]
                : []
    )[],
]
Synchronously parses the value.
Parameters
- input: unknown
  The value to parse.
- Optionaloptions: ParseOptions
  Parsing options.
Returns [
    ...{ [K in string
    | number
    | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
    ...(
        RestShape extends undefined
        | null
            ? []
            : RestShape extends Shape<any, any>
                ? RestShape<RestShape>[typeof OUTPUT][]
                : []
    )[],
]
The value that conforms the output type of the shape.

Throws
Error if the shape doesn't support the sync parsing, see Shape.isAsync.

Throws
ValidationError if any issues occur during parsing.

Inherited from Shape.parse

parseAsync

parseAsync(
    input: unknown,
    options?: ParseOptions,
): Promisify<
    [
        ...{ [K in string
        | number
        | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
        ...(
            RestShape extends undefined
            | null
                ? []
                : RestShape extends Shape<any, any>
                    ? RestShape<RestShape>[typeof OUTPUT][]
                    : []
        )[],
    ],
>
Asynchronously parses the value.
Parameters
- input: unknown
  The value to parse.
- Optionaloptions: ParseOptions
  Parsing options.
Returns Promisify<
    [
        ...{ [K in string
        | number
        | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
        ...(
            RestShape extends undefined
            | null
                ? []
                : RestShape extends Shape<any, any>
                    ? RestShape<RestShape>[typeof OUTPUT][]
                    : []
        )[],
    ],
>
The promise that resolves with the value that conforms the output type of the shape, or rejects with a ValidationError if any issues occur during parsing.

Inherited from Shape.parseAsync

parseOrDefault

parseOrDefault(
    input: unknown,
):
    | undefined
    | [
        ...{ [K in string
        | number
        | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
        ...(
            RestShape extends undefined
            | null
                ? []
                : RestShape extends Shape<any, any>
                    ? RestShape<RestShape>[typeof OUTPUT][]
                    : []
        )[],
    ]
Synchronously parses the value and returns undefined if parsing fails.
Parameters
- input: unknown
  The value to parse.
Returns
    | undefined
    | [
        ...{ [K in string
        | number
        | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
        ...(
            RestShape extends undefined
            | null
                ? []
                : RestShape extends Shape<any, any>
                    ? RestShape<RestShape>[typeof OUTPUT][]
                    : []
        )[],
    ]
The value that conforms the output type of the shape.

Throws
Error if the shape doesn't support the sync parsing, see Shape.isAsync.

Inherited from Shape.parseOrDefault
parseOrDefault<DefaultValue>(
    input: unknown,
    defaultValue: DefaultValue,
    options?: ParseOptions,
):
    | [
        ...{ [K in string
        | number
        | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
        ...(
            RestShape extends undefined
            | null
                ? []
                : RestShape extends Shape<any, any>
                    ? RestShape<RestShape>[typeof OUTPUT][]
                    : []
        )[],
    ]
    | DefaultValue
Synchronously parses the value and returns the default value if parsing fails.
Type Parameters
- DefaultValue
  The default value that is returned if parsing fails.
Parameters
- input: unknown
  The value to parse.
- defaultValue: DefaultValue
  The default value that is returned if parsing fails.
- Optionaloptions: ParseOptions
  Parsing options.
Returns
    | [
        ...{ [K in string
        | number
        | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
        ...(
            RestShape extends undefined
            | null
                ? []
                : RestShape extends Shape<any, any>
                    ? RestShape<RestShape>[typeof OUTPUT][]
                    : []
        )[],
    ]
    | DefaultValue
The value that conforms the output type of the shape.

Throws
Error if the shape doesn't support the sync parsing, see Shape.isAsync.

Inherited from Shape.parseOrDefault

parseOrDefaultAsync

parseOrDefaultAsync(
    input: unknown,
): Promisify<
    | undefined
    | [
        ...{ [K in string
        | number
        | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
        ...(
            RestShape extends undefined
            | null
                ? []
                : RestShape extends Shape<any, any>
                    ? RestShape<RestShape>[typeof OUTPUT][]
                    : []
        )[],
    ],
>
Asynchronously parses the value and returns undefined value if parsing fails.
Parameters
- input: unknown
  The value to parse.
Returns Promisify<
    | undefined
    | [
        ...{ [K in string
        | number
        | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
        ...(
            RestShape extends undefined
            | null
                ? []
                : RestShape extends Shape<any, any>
                    ? RestShape<RestShape>[typeof OUTPUT][]
                    : []
        )[],
    ],
>
The value that conforms the output type of the shape.

Inherited from Shape.parseOrDefaultAsync
parseOrDefaultAsync<DefaultValue>(
    input: unknown,
    defaultValue: DefaultValue,
    options?: ParseOptions,
): Promisify<
    | [
        ...{ [K in string
        | number
        | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
        ...(
            RestShape extends undefined
            | null
                ? []
                : RestShape extends Shape<any, any>
                    ? RestShape<RestShape>[typeof OUTPUT][]
                    : []
        )[],
    ]
    | DefaultValue,
>
Asynchronously parses the value and returns the default value if parsing fails.
Type Parameters
- DefaultValue
  The default value that is returned if parsing fails.
Parameters
- input: unknown
  The value to parse.
- defaultValue: DefaultValue
  The default value that is returned if parsing fails.
- Optionaloptions: ParseOptions
  Parsing options.
Returns Promisify<
    | [
        ...{ [K in string
        | number
        | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
        ...(
            RestShape extends undefined
            | null
                ? []
                : RestShape extends Shape<any, any>
                    ? RestShape<RestShape>[typeof OUTPUT][]
                    : []
        )[],
    ]
    | DefaultValue,
>
The value that conforms the output type of the shape.

Inherited from Shape.parseOrDefaultAsync

readonly

readonly(): ReadonlyShape<ArrayShape<HeadShapes, RestShape>>
Makes an array readonly: array elements cannot be added, removed or updated at runtime.

Returns ReadonlyShape<ArrayShape<HeadShapes, RestShape>>

refine

refine<
    RefinedValue extends
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
    Param,
>(
    cb: RefinePredicate<
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
        RefinedValue,
        Param,
    >,
    options: Message | ParameterizedRefineOptions<Param>,
): RefineShape<ArrayShape<HeadShapes, RestShape>, RefinedValue>
Adds a synchronous operation that refines the shape output type with the narrowing predicate.
Type Parameters
- RefinedValue extends [
      ...{ [K in string
      | number
      | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
      ...(
          RestShape extends undefined
          | null
              ? []
              : RestShape extends Shape<any, any>
                  ? RestShape<RestShape>[typeof OUTPUT][]
                  : []
      )[],
  ]
  The narrowed output value.
- Param
  The param that is passed to the operation when it is applied.
Parameters
- cb: RefinePredicate<
      [
          ...{ [K in string
          | number
          | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
          ...(
              RestShape extends undefined
              | null
                  ? []
                  : RestShape extends Shape<any, any>
                      ? RestShape<RestShape>[typeof OUTPUT][]
                      : []
          )[],
      ],
      RefinedValue,
      Param,
  >
  The predicate that returns true if the value conforms the required type, or false otherwise.
- options: Message | ParameterizedRefineOptions<Param>
  The operation options or the issue message.
Returns RefineShape<ArrayShape<HeadShapes, RestShape>, RefinedValue>
The shape with the narrowed output.
See
Inherited from Shape.refine
refine<
    RefinedValue extends
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
>(
    cb: RefinePredicate<
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
        RefinedValue,
    >,
    options?: Message | RefineOptions,
): RefineShape<ArrayShape<HeadShapes, RestShape>, RefinedValue>
Adds a synchronous operation that refines the shape output type with the narrowing predicate.
Type Parameters
- RefinedValue extends [
      ...{ [K in string
      | number
      | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
      ...(
          RestShape extends undefined
          | null
              ? []
              : RestShape extends Shape<any, any>
                  ? RestShape<RestShape>[typeof OUTPUT][]
                  : []
      )[],
  ]
  The narrowed output value.
Parameters
- cb: RefinePredicate<
      [
          ...{ [K in string
          | number
          | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
          ...(
              RestShape extends undefined
              | null
                  ? []
                  : RestShape extends Shape<any, any>
                      ? RestShape<RestShape>[typeof OUTPUT][]
                      : []
          )[],
      ],
      RefinedValue,
  >
  The predicate that returns true if the value conforms the required type, or false otherwise.
- Optionaloptions: Message | RefineOptions
  The operation options or the issue message.
Returns RefineShape<ArrayShape<HeadShapes, RestShape>, RefinedValue>
The shape with the narrowed output.
See
Inherited from Shape.refine
refine<Param>(
    cb: OperationCallback<
        unknown,
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
        Param,
    >,
    options?: Message | ParameterizedRefineOptions<Param>,
): this
Adds a synchronous operation that checks that the output value conforms the predicate.
Type Parameters
- Param
  The param that is passed to the operation when it is applied.
Parameters
- cb: OperationCallback<
      unknown,
      [
          ...{ [K in string
          | number
          | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
          ...(
              RestShape extends undefined
              | null
                  ? []
                  : RestShape extends Shape<any, any>
                      ? RestShape<RestShape>[typeof OUTPUT][]
                      : []
          )[],
      ],
      Param,
  >
  The predicate that returns truthy result if the value is valid, or returns falsy result otherwise.
- Optionaloptions: Message | ParameterizedRefineOptions<Param>
  The operation options or the issue message.
Returns this
The clone of the shape.
See
Inherited from Shape.refine
refine(
    cb: OperationCallback<
        unknown,
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
    >,
    options?: Message | RefineOptions,
): this
Adds a synchronous operation that checks that the output value conforms the predicate.
Parameters
- cb: OperationCallback<
      unknown,
      [
          ...{ [K in string
          | number
          | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
          ...(
              RestShape extends undefined
              | null
                  ? []
                  : RestShape extends Shape<any, any>
                      ? RestShape<RestShape>[typeof OUTPUT][]
                      : []
          )[],
      ],
  >
  The predicate that returns truthy result if the value is valid, or returns falsy result otherwise.
- Optionaloptions: Message | RefineOptions
  The operation options or the issue message.
Returns this
The clone of the shape.
See
Inherited from Shape.refine

refineAsync

refineAsync<Param>(
    cb: OperationCallback<
        PromiseLike<unknown>,
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
        Param,
    >,
    options?: Message | ParameterizedRefineOptions<Param>,
): this
Adds an asynchronous operation that checks that the output value conforms the predicate.
Type Parameters
- Param
  The param that is passed to the operation when it is applied.
Parameters
- cb: OperationCallback<
      PromiseLike<unknown>,
      [
          ...{ [K in string
          | number
          | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
          ...(
              RestShape extends undefined
              | null
                  ? []
                  : RestShape extends Shape<any, any>
                      ? RestShape<RestShape>[typeof OUTPUT][]
                      : []
          )[],
      ],
      Param,
  >
  The predicate that returns a promise that resolves with a truthy result if the value is valid, or a falsy result otherwise.
- Optionaloptions: Message | ParameterizedRefineOptions<Param>
  The operation options or the issue message.
Returns this
The clone of the shape.
See
Inherited from Shape.refineAsync
refineAsync(
    cb: OperationCallback<
        PromiseLike<unknown>,
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
    >,
    options?: Message | RefineOptions,
): this
Adds an asynchronous operation that checks that the output value conforms the predicate.
Parameters
- cb: OperationCallback<
      PromiseLike<unknown>,
      [
          ...{ [K in string
          | number
          | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
          ...(
              RestShape extends undefined
              | null
                  ? []
                  : RestShape extends Shape<any, any>
                      ? RestShape<RestShape>[typeof OUTPUT][]
                      : []
          )[],
      ],
  >
  The predicate that returns a promise that resolves with a truthy result if the value is valid, or a falsy result otherwise.
- Optionaloptions: Message | RefineOptions
  The operation options or the issue message.
Returns this
The clone of the shape.
See
Inherited from Shape.refineAsync

replace

replace<InputValue extends Any, OutputValue extends Any>(
inputValue: InputValue,
outputValue: OutputValue,
): ReplaceShape<ArrayShape<HeadShapes, RestShape>, InputValue, OutputValue>
Replaces an input value with an output value.
Type Parameters
- InputValue extends Any
  The input value to replace.
- OutputValue extends Any
  The output value that is used as the replacement for an input value.
Parameters
- inputValue: InputValue
  The input value to replace.
- outputValue: OutputValue
  The output value that is returned if an inputValue is received.
Returns ReplaceShape<ArrayShape<HeadShapes, RestShape>, InputValue, OutputValue>
Inherited from Shape.replace

rest

rest<S extends null | AnyShape>(restShape: S): ArrayShape<HeadShapes, S>
Returns an array shape that has rest elements constrained by the given shape.

Note: This method returns a shape without any operations.
Type Parameters
- S extends null | AnyShape
  The shape of rest elements.
Parameters
- restShape: S
  The shape of rest elements, or null if there are no rest elements.
Returns ArrayShape<HeadShapes, S>
The new array shape.

to

to<OutputShape extends AnyShape>(
shape: OutputShape,
): PipeShape<ArrayShape<HeadShapes, RestShape>, OutputShape>
Pipes the output of this shape to the input of another shape.
Type Parameters
- OutputShape extends AnyShape
  The output value.
Parameters
- shape: OutputShape
  The shape that validates the output if this shape.
Returns PipeShape<ArrayShape<HeadShapes, RestShape>, OutputShape>
Inherited from Shape.to

try

try(
    input: unknown,
    options?: ParseOptions,
):
    | Err
    | Ok<
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
    >
Synchronously parses the value and returns Ok or Err object that wraps the result.
Parameters
- input: unknown
  The value to parse.
- Optionaloptions: ParseOptions
  Parsing options.
Returns
    | Err
    | Ok<
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
    >
The Ok instance if parsing has succeeded or Err if parsing has failed.

Throws
Error if the shape doesn't support the sync parsing, see Shape.isAsync.

Inherited from Shape.try

tryAsync

tryAsync(
    input: unknown,
    options?: ParseOptions,
): Promise<
    | Err
    | Ok<
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
    >,
>
Asynchronously parses the value and returns Ok or Err object that wraps the result.
Parameters
- input: unknown
  The value to parse.
- Optionaloptions: ParseOptions
  Parsing options.
Returns Promise<
    | Err
    | Ok<
        [
            ...{
                [K in string
                | number
                | symbol]: HeadShapes[K<K>][typeof OUTPUT]
            }[],
            ...(
                RestShape extends undefined
                | null
                    ? []
                    : RestShape extends Shape<any, any>
                        ? RestShape<RestShape>[typeof OUTPUT][]
                        : []
            )[],
        ],
    >,
>
The Ok instance if parsing has succeeded or Err if parsing has failed.

Inherited from Shape.tryAsync

Plugin Methods

includes

includes(value: any, options?: IssueOptions | Message): this
Requires an array to contain at least one element that conforms the given shape.
Parameters
- value: any
  The shape of the required element or its literal value.
- Optionaloptions: IssueOptions | Message
  The issue options or the issue message.
Returns this
The clone of the shape.

Plugin
plugin/array-essentials

length

length(length: number, options?: IssueOptions | Message): this
Constrains the array length.
Parameters
- length: number
  The minimum array length.
- Optionaloptions: IssueOptions | Message
  The issue options or the issue message.
Returns this
The clone of the shape.

Plugin
plugin/array-essentials

max

max(length: number, options?: IssueOptions | Message): this
Constrains the maximum array length.
Parameters
- length: number
  The maximum array length.
- Optionaloptions: IssueOptions | Message
  The issue options or the issue message.
Returns this
The clone of the shape.

Plugin
plugin/array-essentials

min

min(length: number, options?: IssueOptions | Message): this
Constrains the minimum array length.
Parameters
- length: number
  The minimum array length.
- Optionaloptions: IssueOptions | Message
  The issue options or the issue message.
Returns this
The clone of the shape.

Plugin
plugin/array-essentials

nonEmpty

nonEmpty(options?: IssueOptions | Message): this
Constrains the array length to be at least one element.
Parameters
- Optionaloptions: IssueOptions | Message
  The issue options or the issue message.
Returns this
The clone of the shape.

Plugin
plugin/array-essentials

Class ArrayShape<HeadShapes, RestShape>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Plugin Methods

Constructors

constructor

Type Parameters

Parameters

Returns ArrayShape<HeadShapes, RestShape>

Properties

Protected_options

annotations

See

ReadonlyheadShapes

Readonlyinputs

ReadonlyisAsync

isCoercing

operations

See

ReadonlyrestShape

Methods

Protected_apply

Parameters

Returns Result< [ ...{ [K in string | number | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[], ...( RestShape extends undefined | null ? [] : RestShape extends Shape<any, any> ? RestShape<RestShape>[typeof OUTPUT][] : [] )[], ],>

See

Protected_applyAsync

Parameters

Returns Promise< Result< [ ...{ [K in string | number | symbol]: HeadShapes[K<K>][typeof OUTPUT] }[], ...( RestShape extends undefined | null ? [] : RestShape extends Shape<any, any> ? RestShape<RestShape>[typeof OUTPUT][] : [] )[], ], >,>

See

Protected_applyOperations

Parameters

Returns Result | Promise<Result>

Protected_clone

Returns this

See

Protected_getInputs

Returns readonly unknown[]

See

Protected_isAsync

Returns boolean

See

accepts

Parameters

Returns boolean

addAsyncOperation

Type Parameters

Parameters

Returns this

See

Parameters

Returns this

See

addOperation

Type Parameters

Parameters

Returns this

See

Parameters

Returns this

See

allow

Type Parameters

Parameters

Returns AllowShape<ArrayShape<HeadShapes, RestShape>, AllowedValue>

alter

Type Parameters

Parameters

Returns this

See

Parameters

Returns this

See

alterAsync

Type Parameters

Parameters

`Protected`_options

`Readonly`headShapes

`Readonly`inputs

`Readonly`isAsync

`Readonly`restShape

`Protected`_apply

Returns Result<
[
...{ [K in string
| number
| symbol]: HeadShapes[K<K>][typeof OUTPUT] }[],
...(
RestShape extends undefined
| null
? []
: RestShape extends Shape<any, any>
? RestShape<RestShape>[typeof OUTPUT][]
: []
)[],
],
>

`Protected`_applyAsync

Returns Promise<
Result<
[
...{
[K in string
| number
| symbol]: HeadShapes[K<K>][typeof OUTPUT]
}[],
...(
RestShape extends undefined
| null
? []
: RestShape extends Shape<any, any>
? RestShape<RestShape>[typeof OUTPUT][]
: []
)[],
],
>,
>

`Protected`_applyOperations

`Protected`_clone

`Protected`_getInputs

`Protected`_isAsync

Returns RefineShape<
ArrayShape<HeadShapes, RestShape>,
Branded<
[
...{
[K in string
| number
| symbol]: HeadShapes[K<K>][typeof OUTPUT]
}[],
...(
RestShape extends undefined
| null
? []
: RestShape extends Shape<any, any>
? RestShape<RestShape>[typeof OUTPUT][]
: []
)[],
],
Brand,
>,
>

Returns Shape<
[
...{ [K in string
| number
| symbol]: HeadShapes[K<K>][typeof INPUT] }[],
...(
RestShape extends undefined
| null
? []
: RestShape extends Shape<any, any>
? RestShape<RestShape>[typeof INPUT][]
: []
)[],
],
ConvertedValue,
>

Returns Shape<
[
...{ [K in string
| number
| symbol]: HeadShapes[K<K>][typeof INPUT] }[],
...(
RestShape extends undefined
| null
? []
: RestShape extends Shape<any, any>
? RestShape<RestShape>[typeof INPUT][]
: []
)[],
],
ConvertedValue,
>