isEmpty

Checks if a plain object has no own enumerable string-keyed properties. null and undefined are treated as empty objects and return true.

Symbol-keyed properties are not counted. Use Object.getOwnPropertySymbols separately if symbol keys matter for your use case.

Available since v2.0.3

Import

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

Signature

isEmpty(value: Record<PropertyKey, unknown> | null | undefined): boolean

Parameters

Parameter	Type	Description
value	Record<PropertyKey, unknown> | null | undefined	The object to check

Returns

boolean — true if the object has no own enumerable string-keyed properties, or if value is null/undefined

Examples

Check if an object has no own string-keyed properties

Returns true for {}. Symbol-keyed properties are not counted.

isEmpty({})              // => true
isEmpty({ a: 1 })        // => false
isEmpty({ a: undefined }) // => false  (key exists even if value is undefined)

Symbol keys are not counted

An object with only symbol-keyed properties is considered empty.

const sym = Symbol('x');
const obj = { [sym]: 1 };
isEmpty(obj) // => true  (only string keys are counted)

Name conflict

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

import { isEmpty as isEmpty4object } from '@helpers4/object';
import { isEmpty as isEmpty4array } from '@helpers4/array';
import { isEmpty as isEmpty4string } from '@helpers4/string';

See Name Conflicts for the full resolution guide.

Source

View source on GitHub