isPrimitive

Checks whether a value is a JavaScript primitive.

JavaScript primitives include null, undefined, strings, numbers, booleans, symbols, and bigints.

Signature

function isPrimitive(value: unknown): value is null | undefined | string | number | boolean | symbol | bigint;

Parameters

• value (unknown): The value to check.

Returns

(value is null | undefined | string | number | boolean | symbol | bigint): True if the value is a primitive, otherwise false.

Examples

import { isPrimitive } from 'es-toolkit/predicate';

isPrimitive(null); // true
isPrimitive(undefined); // true
isPrimitive('123'); // true
isPrimitive(false); // true
isPrimitive(true); // true
isPrimitive(Symbol('a')); // true
isPrimitive(123n); // true
isPrimitive({}); // false
isPrimitive(new Date()); // false
isPrimitive(new Map()); // false
isPrimitive(new Set()); // false
isPrimitive([1, 2, 3]); // false