compact

Removes all falsy values (false, null, undefined, 0, "", NaN) from an array. null and undefined are treated as empty arrays and return [].

Available since v2.0.0

Import

import { compact } from '@helpers4/array';

Signature

compact<T>(array: readonly Falsy | T[] | null | undefined): Exclude<T, Falsy>[]

Parameters

Parameter	Type	Description
array	readonly Falsy | T[] | null | undefined	The array to compact

Returns

Exclude<T, Falsy>[] — A new array with only truthy values

Examples

Remove falsy values

Removes all falsy values (false, null, undefined, 0, "", NaN) from an array.

compact([0, 1, false, 2, '', 3, null, undefined, NaN])
// => [1, 2, 3]

Filter nullable strings

Useful to clean up arrays with null/undefined gaps.

compact(['hello', null, 'world', undefined, ''])
// => ['hello', 'world']

Name conflict

A helper named compact also exists in @helpers4/object. If you need both in the same file, rename at import with as:

import { compact as compact4array } from '@helpers4/array';
import { compact as compact4object } from '@helpers4/object';

See Name Conflicts for the full resolution guide.

Source

View source on GitHub