isSymbol

lang

Checks if value is classified as a Symbol primitive or object.

Installation

Import

import { isSymbol } from '@tulx/utils';

Source Code

Implementation

/**
 * Checks if value is classified as a Symbol primitive or object.
 *
 * @param value - The value to check.
 * @returns Returns true if value is a symbol, else false.
 *
 * @example
 * ```ts
 * isSymbol(Symbol.iterator); // true
 * isSymbol('abc'); // false
 * ```
 */
export function isSymbol(value: unknown): value is symbol {
  return (
    typeof value === 'symbol' ||
    (typeof value === 'object' &&
      value !== null &&
      Object.prototype.toString.call(value) === '[object Symbol]')
  );
}

Example

import { isSymbol } from '@tulx/utils';

isSymbol(Symbol.iterator); // true
isSymbol('abc'); // false

Related Functions

castArray

Casts value as an array if it's not one.

clone

Creates a shallow clone of value.

cloneDeep

This method is like clone except that it recursively clones value.

cloneDeepWith

This method is like cloneDeep except that it accepts customizer which is invoked to produce the cloned value.

cloneWith

This method is like clone except that it accepts customizer which is invoked to produce the cloned value.

conformsTo

Checks if object conforms to source by invoking the predicate properties of source with the corresponding property values of object.