Function array

array<T>(decoder: Decoder<T>): Decoder<T[]>

Decoder for arrays.

Type Parameters

T

Parameters

decoder: Decoder<T>
The decoder for array elements

Returns Decoder<T[]>

A decoder that validates and returns arrays

Example

const numberArray = JsonDecoder.array(JsonDecoder.number());

numberArray.decode([1, 2, 3]); // Ok<number[]>

// All element failures are collected before returning:
numberArray.decode([1, '2', '3']);
// Err({ issues: [
//   { message: '"2" is not a valid number', path: [1] },
//   { message: '"3" is not a valid number', path: [2] }
// ] })