compact

Removes all entries with falsy values (false, null, undefined, 0, "", NaN) from an object. Own keys that are prototype-polluting strings (__proto__, constructor, prototype) are silently skipped.

Available since v2.0.0

Import

import { compact } from '@helpers4/object';
// or, from the all-in-one package (same code, one install):
import { compact } from 'helpers4/object';

Signature

compact<T extends Record<string, unknown>>(obj: T): Partial<T>

Parameters

Parameter	Type	Description
obj	T	The source object

Returns

Partial<T> — A new object containing only entries with truthy values

Examples

Remove falsy values from object

Removes all entries with falsy values (false, null, undefined, 0, "", NaN).

compact({ a: 1, b: null, c: '', d: 0, e: 'hello' })
// => { a: 1, e: 'hello' }

Clean up API response

Useful to strip empty or missing fields before sending data.

compact({ name: 'Alice', email: '', age: 0, role: 'admin' })
// => { name: 'Alice', role: 'admin' }

Name conflict

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

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

See Name Conflicts for the full resolution guide.

Source

View source on GitHub