isEmpty

INFO

This function is only available in es-toolkit/compat for compatibility reasons. It either has alternative native JavaScript APIs or isn’t fully optimized yet.

When imported from es-toolkit/compat, it behaves exactly like lodash and provides the same functionalities, as detailed here.

Checks if a given value is empty.

• If the given value is a string, checks if it is an empty string.
• If the given value is an array, Map, or Set, checks if its size is 0.
• If the given value is an array-like object, checks if its length is 0.
• If the given value is an object, checks if it is an empty object with no properties.
• Primitive values (strings, booleans, numbers, or bigints) are considered empty.

Signature

function isEmpty(value: string): value is '';
function isEmpty(value: Map<any, any>): boolean;
function isEmpty(value: Set<any>): boolean;
function isEmpty(value: any[]): value is [];
function isEmpty<T extends Record<any, any>>(
  value: T | null | undefined
): value is Record<keyof T, never> | null | undefined;
function isEmpty(value: unknown): boolean;

Parameters

• value (unknown): The value to check.

Returns

(boolean): true if the value is empty, false otherwise.

Examples

isEmpty(); // true
isEmpty(null); // true
isEmpty(''); // true
isEmpty([]); // true
isEmpty({}); // true
isEmpty(new Map()); // true
isEmpty(new Set()); // true
isEmpty('hello'); // false
isEmpty([1, 2, 3]); // false
isEmpty({ a: 1 }); // false
isEmpty(new Map([['key', 'value']])); // false
isEmpty(new Set([1, 2, 3])); // false