Core

struct.array

Struct that parses an array with one item struct.

Chapter navigation

@defjs/core · Function

Signature

function array<
  S extends StructLike<unknown, unknown, boolean>,
>(item: S): ArrayStruct<S>;

Parses every element with item and outputs a new array. A non-array fails with invalid_type (expected array).
Parsing stops at the first failing element, and issue.path holds its index.
Throws TypeError when item is not a struct.

ArrayStruct<S> is not exported. It is a Struct<StructInput<S>[], Infer<S>[]>.

Prop

Type

item S

struct.any

Struct that accepts any value except null and undefined, without validation.

struct.arrayBuffer

Struct that accepts an ArrayBuffer.