@zerodep/is-nil

A simple, performant utility to determine if a value is null or undefined.

Full documentation is available at the zerodep.app page.

Signature

declare const isNil: (value: unknown) => boolean;

Examples

All @zerodep packages support both ESM and CJS formats, each complete with Typescript typings.

// ESM
import { isNil } from '@zerodep/is-nil';

// CJS
const { isNil } = require('@zerodep/is-nil');

// Arrays
isNil([]); // false
isNil([1, 2, 3]); // false
isNil(['a', 'b', 'c']); // false

// BigInts
isNil(42n); // false
isNil(0n); // false
isNil(-0n); // false
isNil(-42n); // false

// Booleans
isNil(true); // false
isNil(false); // false

// Class
isNil(
  class SomeClass {
    constructor() {}
  }
); // false

// Dates
isNil(new Date()); // false
isNil(new Date('1970-01-01T12:00:00.000Z')); // false
isNil(new Date('2099-12-31')); // false

// Empty
isNil(null); // true
isNil(undefined); // true

// Errors
isNil(new Error('message')); // false
isNil(new AggregateError([new Error('err1'), new Error('err2')], 'message')); // false

// Floats
isNil(3.14); // false
isNil(0.0); // false
isNil(-0.0); // false
isNil(-3.14); // false
isNil(Math.E); // false
isNil(Math.PI); // false
isNil(Number.MIN_VALUE); // false

// Functions
isNil(() => 'function'); // false
isNil(async () => 'function'); // false

// Generators
isNil(function* () {
  yield 'a';
}); // false
isNil(async function* () {
  yield 'a';
}); // false

// Maps
isNil(new Map()); // false
isNil(new Map([['key1', 123]])); // false
isNil(new Map([['key1', 'value1']])); // false

// Numbers
isNil(Number.POSITIVE_INFINITY); // false
isNil(Number.MAX_SAFE_INTEGER); // false
isNil(3e8); // false
isNil(42); // false
isNil(1); // false
isNil(0); // false
isNil(-0); // false
isNil(-1); // false
isNil(-42); // false
isNil(-3e8); // false
isNil(Number.MIN_SAFE_INTEGER); // false
isNil(Number.NEGATIVE_INFINITY); // false
isNil(Number.NaN); // false

// POJOs
isNil({}); // false
isNil({ key: 'string' }); // false
isNil({ key: 123 }); // false

// Promise
isNil(new Promise(() => {})); // false
isNil(new Promise.all([])); // false
isNil(new Promise.allSettled([])); // false
isNil(new Promise.race([])); // false
isNil(Promise.resolve()); // false

// Regular Expression
isNil(/[regex]+/gi); // false
isNil(new RegExp('d', 'gi')); // false

// Sets
isNil(new Set()); // false
isNil(new Set([1, 2, 3])); // false
isNil(new Set(['a', 'b', 'c'])); // false

// Strings
isNil(''); // false
isNil('a longer string'); // false
isNil('1000n'); // false
isNil('3e8'); // false
isNil('42'); // false
isNil('3.14'); // false
isNil('0'); // false
isNil('-0'); // false
isNil('-3.14'); // false
isNil('-42'); // false
isNil('-3e8'); // false
isNil('-1000n'); // false

// Symbols
isNil(Symbol()); // false
isNil(Symbol('name')); // false

// This
isNil(this); // false
isNil(globalThis); // false

// TypedArrays
isNil(new Int8Array(2)); // false
isNil(new Int16Array(2)); // false
isNil(new Int32Array(2)); // false
isNil(new Uint8Array(2)); // false
isNil(new Uint16Array(2)); // false
isNil(new Uint32Array(2)); // false
isNil(new Uint8ClampedArray(2)); // false

isNil(new BigInt64Array(2)); // false
isNil(new BigUint64Array(2)); // false

isNil(new Float32Array(2)); // false
isNil(new Float64Array(2)); // false

isNil(new SharedArrayBuffer(512)); // false

// WeakMap and WeakSet
isNil(new WeakMap()); // false
isNil(new WeakSet()); // false

ZeroDep Advantages

• Zero npm dependencies - completely eliminates all risk of supply-chain attacks, decreases node_modules folder size
• ESM & CJS - has both ecmascript modules and common javascript exports
• Tree Shakable - built to be fully tree shakable ensuring your packages are the smallest possible size
• Fully typed - typescript definitions are provided for every package for a better developer experience
• Semantically named - package and method names are easy to grok, remember, use, and read
• Documented - actually useful documentation with examples at zerodep.app
• Intelligently Packaged - multiple npm packages of different sizes available allowing a menu or a-la-carte composition of capabilities
• 100% Tested - all methods and packages are fully unit tested
• Predictably Versioned - semantically versioned for peace-of-mind upgrading, this includes changelogs
• MIT Licensed - permissively licensed for maximum usability