@xylabs/array

[![logo][]](https://xylabs.com)

[![main-build][]][main-build-link]
[![npm-badge][]][npm-link]
[![npm-downloads-badge][]][npm-link]
[![jsdelivr-badge][]][jsdelivr-link]
[![npm-license-badge][]](LICENSE)
[![codacy-badge][]][codacy-link]
[![codeclimate-badge][]][codeclimate-link]
[![snyk-badge][]][snyk-link]
[![socket-badge][]][socket-link]

Base functionality used throughout XY Labs TypeScript/JavaScript libraries

Reference

@xylabs/array

*

Functions

- containsAll
- distinct
- filterAs
- filterAsync
- findAs
- findLastAs
- flatten
- uniq
- uniqBy

$3

### containsAll

@xylabs/array

*

``ts
function containsAll(source, target): boolean;
`

Type Parameters

$3

T

Parameters

$3

T[]

$3

T[]

Returns

boolean

### distinct

@xylabs/array

*

`ts
function distinct(
value,
index,
array): boolean;
`

Type Parameters

$3

T

Parameters

$3

T

$3

number

$3

T[]

Returns

boolean

### filterAs

@xylabs/array

*

`ts
function filterAs(x, predicate): NonNullable[];
`

Type Parameters

$3

In

$3

Out

Parameters

$3

In[]

$3

(a) => Out

Returns

NonNullable\<Out\>[]

### filterAsync

@xylabs/array

*

`ts
function filterAsync(array, predicate): Promise;
`

Returns the elements of an array that meet the condition specified in a callback function.

Type Parameters

$3

T

Parameters

$3

T[]

The array to filter.

$3

(value, index, array) => Promise\<boolean\>

A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

Returns

Promise\<T[]\>

The elements of an array that meet the condition specified in a callback function.

### findAs

@xylabs/array

*

`ts
function findAs(x, predicate): undefined | NonNullable;
`

Type Parameters

$3

In

$3

Out

Parameters

$3

In[]

$3

(a) => Out

Returns

undefined \| NonNullable\<Out\>

### findLastAs

@xylabs/array

*

`ts
function findLastAs(x, predicate): undefined | NonNullable;
`

Type Parameters

$3

In

$3

Out

Parameters

$3

In[]

$3

(a) => Out

Returns

undefined \| NonNullable\<Out\>

### flatten

@xylabs/array

*

`ts
function flatten(a?, b?): T[];
`

Type Parameters

$3

T

Parameters

$3

T | ConcatArray\<T\>

$3

T | ConcatArray\<T\>

Returns

T[]

### uniq

@xylabs/array

*

`ts
function uniq(arr): T[];
`

Type Parameters

$3

T

Parameters

$3

T[]

Returns

T[]

### uniqBy

@xylabs/array

*

`ts
function uniqBy(arr, iteratee): T[];
`

Type Parameters

$3

T

$3

I

Parameters

$3

T[]

$3

(item) => I

Returns

T`[]

Part of sdk-js

Maintainers

- Arie Trouw (arietrouw.com)
- Matt Jones
- Joel Carter
- Jordan Trouw

License

> See the LICENSE file for license details

Credits

Made with 🔥 and ❄️ by XYLabs

[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg

[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
[npm-badge]: https://img.shields.io/npm/v/@xylabs/array.svg
[npm-link]: https://www.npmjs.com/package/@xylabs/array
[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json

[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/array
[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/array

[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/array/badge
[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/array

[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/array
[socket-link]: https://socket.dev/npm/package/@xylabs/array