is-arguments

What is is-arguments?

The is-arguments npm package is designed to check if a given value is an arguments object. This can be particularly useful in functions where you need to differentiate between an array and the arguments object, or when trying to ensure compatibility across different JavaScript environments where the typeof operator might not suffice.

What are is-arguments's main functionalities?

Check if a value is an arguments object

This feature allows you to check if a given value is an arguments object. It's particularly useful in scenarios where you need to distinguish between an array and the arguments object passed to a function.

const isArguments = require('is-arguments');

function example() {
  console.log(isArguments(arguments)); // true
  console.log(isArguments([1, 2, 3])); // false
}

example();

Other packages similar to is-arguments

isarray

Similar to is-arguments, isarray checks if a given value is an array. While is-arguments focuses on identifying arguments objects, isarray focuses on arrays. Both packages serve to identify specific data structures, making them useful in different but somewhat related scenarios.

lodash.isarguments

Part of the Lodash library, lodash.isarguments provides a similar functionality to is-arguments by checking if a value is an arguments object. The main difference is that lodash.isarguments comes as part of the larger Lodash utility library, which offers a wide range of functions for different types of data manipulation and checking.

README

is-arguments

Is this an arguments object? It's a harder question than you think.

Example

var isArguments = require('is-arguments');
var assert = require('assert');

assert.equal(isArguments({}), false);
assert.equal(isArguments([]), false);
(function () {
	assert.equal(isArguments(arguments), true);
}())

Caveats

If you have modified an actual arguments object by giving it a Symbol.toStringTag property, then this package will return false.

Tests

Simply clone the repo, npm install, and run npm test

Changelog

v1.2.0 - 2024-12-12

Commits

• [actions] reuse common workflows ff7c948
• [New] add types 5fe6c6e
• [meta] use npmignore to autogenerate an npmignore file 9a9b0cf
• [actions] split out node 10-20, and 20+ 74c5c49
• [Dev Deps] update eslint, @ljharb/eslint-config, safe-publish-latest, tape d9a932d
• [readme] update URLs 0f726b6
• [Dev Deps] update eslint, @ljharb/eslint-config, aud, auto-changelog, tape ea21450
• [actions] update rebase action to use reusable workflow eaad2ab
• [actions] cleanup 2be15d3
• [actions] update codecov uploader 29b929c
• [Dev Deps] update @ljharb/eslint-config, auto-changelog, npmignore, tape 8a38bf5
• [Dev Deps] update @ljharb/eslint-config, safe-publish-latest, tape 841627d
• [Refactor] use call-bound directly e429257
• [Deps] update call-bind, has-tostringtag c0db6a8
• [Tests] replace aud with npm audit f589983
• [meta] add sideEffects flag 2e15793
• [Dev Deps] add missing peer dep 0ffe01b