Class ArrayCore

Array core functions

Since

v1.0.0

Index

Methods

assert assertNot asyncFilter buildErr filter is isEmpty isNot isNotEmpty map

Methods

`Static`assert

assert(value: unknown): asserts value is AnyArrayType<unknown>
Assert that a value is an array
Parameters
- value: unknown
  The value to check
Returns asserts value is AnyArrayType<unknown>
Throws
If the value is not an array

Since
v1.0.0
- Defined in src/lib/ArrayCore.mts:110

`Static`assertNot

assertNot<T>(value: unknown): asserts value is Exclude<T, AnyArrayType<unknown>>
Assert that a value is NOT an array
Type Parameters
- T
Parameters
- value: unknown
  The value to check
Returns asserts value is Exclude<T, AnyArrayType<unknown>>
Throws
If the value is an array

Since
v1.0.0
- Defined in src/lib/ArrayCore.mts:122

`Static`asyncFilter

asyncFilter<T>(
    list: Loadable<Iterable<T, any, any>>,
    asyncPredicate: (
        item: T,
        index: number,
        array: T[],
    ) => boolean | Promise<boolean>,
): Promise<T[]>
Async filter version of Array.prototype.filter(), with the same signature as its synchronous counterpart.
Type Parameters
- T
  The type of the array
Parameters
- list: Loadable<Iterable<T, any, any>>
  The iterable to filter
- asyncPredicate: (item: T, index: number, array: T[]) => boolean | Promise<boolean>
  The predicate function
Returns Promise<T[]>
A promise that resolves to the filtered array
Example
```
ArrayCore.asyncFilter([1, 2, 3], (item) => Promise.resolve(item % 2 === 0)); // [2]
```
Since
v1.0.0
- Defined in src/lib/ArrayCore.mts:53

`Static`buildErr

buildErr(value: unknown): TypeError
Builds an type error Invalid Iterable: ${JSON.stringify(value)}.
Parameters
- value: unknown
  The invalid value.
Returns TypeError
The created error.

Since
v1.0.0
- Defined in src/lib/ArrayCore.mts:154

`Static`filter

filter<T>(
list: Iterable<T, any, any> | (() => Iterable<T>),
predicate: (item: T, index: number, array: T[]) => boolean,
): T[]
Array filter function with iterable which can be also iterable from a function callback.
Type Parameters
- T
  The type of the array
Parameters
- list: Iterable<T, any, any> | (() => Iterable<T>)
  The iterable to filter
- predicate: (item: T, index: number, array: T[]) => boolean
  The predicate function
Returns T[]
The filtered array
Example
```
ArrayCore.filter(() => [1, 2, 3], (item) => item % 2 === 0); // [2]
```
Since
v1.0.0
- Defined in src/lib/ArrayCore.mts:39

`Static`is

is(array: unknown): array is AnyArrayType<unknown>
Type guard to check if a value is an array
Parameters
- array: unknown
  The value to check
Returns array is AnyArrayType<unknown>
True if the value is an array; otherwise, false

Since
v1.0.0
- Defined in src/lib/ArrayCore.mts:90

`Static`isEmpty

isEmpty(array: unknown): array is []
Type guard to check if an array is empty
Parameters
- array: unknown
  The array to check
Returns array is []
True if the array is empty, false otherwise

Since
v1.0.0
- Defined in src/lib/ArrayCore.mts:134

`Static`isNot

isNot<T>(value: unknown): value is Exclude<T, AnyArrayType<unknown>>
Type guard to check if a value is not an array
Type Parameters
- T
Parameters
- value: unknown
  The value to check
Returns value is Exclude<T, AnyArrayType<unknown>>
True if the value is not an array; otherwise, false

Since
v1.0.0
- Defined in src/lib/ArrayCore.mts:100

`Static`isNotEmpty

isNotEmpty<T>(array: unknown): array is NonEmptyArray<T>
Type guard to check if an array is not empty
Type Parameters
- T
Parameters
- array: unknown
  The array to check
Returns array is NonEmptyArray<T>
True if the array is not empty, false otherwise

Since
v1.0.0
- Defined in src/lib/ArrayCore.mts:144

`Static`map

map<
    Target,
    Source extends NonEmptyArray<unknown> | NonEmptyReadonlyArray<unknown>,
>(
    data: Source,
    callback: MapCallback<Target, Source>,
): NonEmptyArray<Target>
Array map function with overload for NonEmptyArray
Type Parameters
- Target
  The type of the array to map to
- Source extends NonEmptyArray<unknown> | NonEmptyReadonlyArray<unknown>
  The type of the array to map from
Parameters
- data: Source
  The array to map
- callback: MapCallback<Target, Source>
  Callback function to map data from the array
Returns NonEmptyArray<Target>
Mapped array
Example
```
const data = [{value: 'value'}] as const;
const result1: NonEmptyReadonlyArray<'value'> = arrayMap(data, (value) => value.value); // pick type from data
const result2: NonEmptyReadonlyArray<'value'> = arrayMap<'value', typeof data>(data, (value) => value.value); // enforce output type
```
Since
v1.0.0
- Defined in src/lib/ArrayCore.mts:75
map<Target, Source extends unknown[] | readonly unknown[]>(
data: Source,
callback: MapCallback<Target, Source>,
): Target[]
Array map function with overload for NonEmptyArray
Type Parameters
- Target
  The type of the array to map to
- Source extends unknown[] | readonly unknown[]
  The type of the array to map from
Parameters
- data: Source
  The array to map
- callback: MapCallback<Target, Source>
  Callback function to map data from the array
Returns Target[]
Mapped array
Example
```
const data = [{value: 'value'}] as const;
const result1: NonEmptyReadonlyArray<'value'> = arrayMap(data, (value) => value.value); // pick type from data
const result2: NonEmptyReadonlyArray<'value'> = arrayMap<'value', typeof data>(data, (value) => value.value); // enforce output type
```
Since
v1.0.0
- Defined in src/lib/ArrayCore.mts:79

Class ArrayCore

Since

Index

Methods

Methods

Staticassert

Parameters

Returns asserts value is AnyArrayType<unknown>

Throws

Since

StaticassertNot

Type Parameters

Parameters

Returns asserts value is Exclude<T, AnyArrayType<unknown>>

Throws

Since

StaticasyncFilter

Type Parameters

Parameters

Returns Promise<T[]>

Example

Since

StaticbuildErr

Parameters

Returns TypeError

Since

Staticfilter

Type Parameters

Parameters

Returns T[]

Example

Since

Staticis

Parameters

Returns array is AnyArrayType<unknown>

Since

StaticisEmpty

Parameters

Returns array is []

Since

StaticisNot

Type Parameters

Parameters

Returns value is Exclude<T, AnyArrayType<unknown>>

Since

StaticisNotEmpty

Type Parameters

Parameters

Returns array is NonEmptyArray<T>

Since

Staticmap

Type Parameters

Parameters

Returns NonEmptyArray<Target>

Example

Since

Type Parameters

Parameters

Returns Target[]

Example

Since

Settings

On This Page

`Static`assert

`Static`assertNot

`Static`asyncFilter

`Static`buildErr

`Static`filter

`Static`is

`Static`isEmpty

`Static`isNot

`Static`isNotEmpty

`Static`map