isReference

Reference types include objects, arrays, functions, and other non-primitive types. A function that checks whether a given argument is a reference type.

Code

🔗 View source code

Interface

typescript

export type Reference =
  | object
  | any[]
  | Function
  | Set<any>
  | Map<any, any>
  | WeakMap<object, any>
  | WeakSet<object>
  | Date
  | RegExp
  | Error;

const isReference: (value: unknown) => value is Reference

Usage

typescript

import { isReference } from '@modern-kit/utils';

isReference({}); // true
isReference([]); // true
isReference(new Set()); // true
isReference(new Map()); // true
isReference(new WeakSet()); // true
isReference(new WeakMap()); // true
isReference(new Date()); // true
isReference(new Error()); // true

isReference(null); // false
isReference(undefined); // false
isReference('string'); // false
isReference(1); // false
isReference(false); // false
isReference(Symbol()); // false