source: node_modules/es-toolkit/dist/predicate/isSymbol.d.ts

Last change on this file was a762898, checked in by istevanoska <ilinastevanoska@…>, 5 months ago

Added visualizations

  • Property mode set to 100644
File size: 767 bytes
Line 
1/**
2 * Check whether a value is a symbol.
3 *
4 * This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to `symbol`.
5 *
6 * @param {unknown} value The value to check.
7 * @returns {value is symbol} Returns `true` if `value` is a symbol, else `false`.
8 *
9 * @example
10 * import { isSymbol } from 'es-toolkit/predicate';
11 *
12 * isSymbol(Symbol('a')); // true
13 * isSymbol(Symbol.for('a')); // true
14 * isSymbol(Symbol.iterator); // true
15 *
16 * isSymbol(null); // false
17 * isSymbol(undefined); // false
18 * isSymbol('123'); // false
19 * isSymbol(false); // false
20 * isSymbol(123n); // false
21 * isSymbol({}); // false
22 * isSymbol([1, 2, 3]); // false
23 */
24declare function isSymbol(value: unknown): value is symbol;
25
26export { isSymbol };
Note: See TracBrowser for help on using the repository browser.