isArguments

INFO

This function is only available in es-toolkit/compat for compatibility reasons. It either has alternative native JavaScript APIs or isn’t fully optimized yet.

When imported from es-toolkit/compat, it behaves exactly like lodash and provides the same functionalities, as detailed here.

Check if a value is an arguments object.

It returns true if the value is an arguments object, and false otherwise.

This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to an arguments object.

Signature

function isArguments(value: unknown): value is IArguments;

Parameters

• value (unknown): The value to test if it is an arguments object.

Returns

(value is IArguments): Returns true if the value is an arguments, false otherwise.

Examples

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

const args = (function () {
  return arguments;
})();
const strictArgs = (function () {
  'use strict';
  return arguments;
})();
const value = [1, 2, 3];

console.log(isArguments(args)); // true
console.log(isArguments(strictArgs)); // true
console.log(isArguments(value)); // false