assertArray()function

assertArray(arr: MutableArray<T>, min: 1, max: 1, caller?: AnyCaller): asserts arr is [T]

assertArray(arr: MutableArray<T>, min: 2, max: 2, caller?: AnyCaller): asserts arr is [T, T]

assertArray(arr: MutableArray<T>, min: 3, max: 3, caller?: AnyCaller): asserts arr is [T, T, T]

assertArray(arr: MutableArray<T>, min?: 1, max?: number, caller?: AnyCaller): asserts arr is [T, ...T[]]

assertArray(arr: MutableArray<T>, min: 2, max?: number, caller?: AnyCaller): asserts arr is [T, T, ...T[]]

assertArray(arr: MutableArray<T>, min: 3, max?: number, caller?: AnyCaller): asserts arr is [T, T, T, ...T[]]

assertArray(arr: MutableArray<T>, min: number, max?: number, caller?: AnyCaller): asserts arr is MutableArray<T>

assertArray(arr: ImmutableArray<T>, min: 1, max: 1, caller?: AnyCaller): asserts arr is readonly [T]

assertArray(arr: ImmutableArray<T>, min: 2, max: 2, caller?: AnyCaller): asserts arr is readonly [T, T]

assertArray(arr: ImmutableArray<T>, min: 3, max: 3, caller?: AnyCaller): asserts arr is readonly [T, T, T]

assertArray(arr: ImmutableArray<T>, min?: 1, max?: number, caller?: AnyCaller): asserts arr is readonly [T, ...T[]]

assertArray(arr: ImmutableArray<T>, min: 2, max?: number, caller?: AnyCaller): asserts arr is readonly [T, T, ...T[]]

assertArray(arr: ImmutableArray<T>, min: 3, max?: number, caller?: AnyCaller): asserts arr is readonly [T, T, T, ...T[]]

assertArray(arr: ImmutableArray<T>, min?: number, max?: number, caller?: AnyCaller): asserts arr is ImmutableArray<T>

Param	Type
`arr`	`MutableArray<T>`	Mutable array: an array that can be changed. required
`min`	`1`	Minimum number of items the array must contain (defaults to `0`). required
`max`	`1`	Maximum number of items the array may contain (defaults to `Infinity`). required
`caller`	`AnyCaller`	Function to attribute a thrown error to (defaults to `assertArray` itself).
`min`	`2`	required
`max`	`2`	required
`caller`	`AnyCaller`	Any calling function or constructor, usually referring to something that can call in the current scope that can appear in a stack trace.
`min`	`3`	required
`max`	`3`	required
`min`	`1`
`max`	`number`
`min`	`number`	required
`arr`	`ImmutableArray<T>`	Immutable array: an array that cannot be changed. required
`min`	`1`	required
`max`	`1`	required
`min`	`number`

Return
`asserts arr is [T]`
`asserts arr is [T, T]`
`asserts arr is [T, T, T]`
`asserts arr is [T, ...T[]]`
`asserts arr is [T, T, ...T[]]`
`asserts arr is [T, T, T, ...T[]]`
`asserts arr is MutableArray<T>`
`asserts arr is readonly [T]`
`asserts arr is readonly [T, T]`
`asserts arr is readonly [T, T, T]`
`asserts arr is readonly [T, ...T[]]`
`asserts arr is readonly [T, T, ...T[]]`
`asserts arr is readonly [T, T, T, ...T[]]`
`asserts arr is ImmutableArray<T>`

Throws
`RequiredError`	If `value` is not an array within the length bounds.

Assert that an unknown value is an array (optionally with specified min/max length).

Examples

assertArray([1, 2, 3]); // (passes)

assertArray("nope"); // throws RequiredError