isArguments

lang

Checks if value is likely an arguments object.

Installation

Import

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

Source Code

Implementation

/**
 * Checks if value is likely an arguments object.
 *
 * @param value - The value to check.
 * @returns Returns true if value is an arguments object, else false.
 *
 * @example
 * ```ts
 * isArguments(function() { return arguments; }()); // true
 * isArguments([1, 2, 3]); // false
 * ```
 */
export function isArguments(value: unknown): value is IArguments {
  return (
    typeof value === 'object' &&
    value !== null &&
    'callee' in value &&
    typeof (value as { callee: unknown }).callee === 'function'
  );
}

Example

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

isArguments(function() { return arguments; }()); // true
isArguments([1, 2, 3]); // 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.