Usage

isEmpty(0); // => true
isEmpty(null); // => true
isEmpty(undefined); // => true
isEmpty([]); // => true
isEmpty({}); // => true

Installation

CLI

npx atmx add helper is-empty

Manually

Copy and paste the following method into @/utils/helpers/undefined.ts:

import { isNumber } from "@/helpers/is-number.ts";
import { isDate } from "@/helpers/is-date.ts";
import { isFunction } from "@/helpers/is-function.ts";
import { isSymbol } from "@/helpers/is-symbol.ts";

/**
* Return true if the given value is empty.
*
* Empty values include:
* - `null`
* - `undefined`
* - `0`
* - `NaN`
* - `''`
* - `[]`
* - `{}`
* - invalid `Date` time
* - object with `length` property of `0`
* - object with `size` property of `0`
* - object with no enumerable keys
*
* @example
* isEmpty(0) // => true
* isEmpty(null) // => true
* isEmpty(undefined) // => true
* isEmpty([]) // => true
* isEmpty({}) // => true
*/
export function isEmpty(value: any): boolean {
if (value === true || value === false) {
return true;
}

if (value === null || value === undefined) {
return true;
}

if (isNumber(value)) {
return value === 0;
}

if (isDate(value)) {
return Number.isNaN(value.getTime());
}

if (isFunction(value)) {
return false;
}

if (isSymbol(value)) {
return false;
}

const length = (value as any).length;

if (isNumber(length)) {
return length === 0;
}

const size = (value as any).size;

if (isNumber(size)) {
return size === 0;
}

return Object.keys(value).length === 0;
}