# isArguments
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Test if a value is an arguments object.
## Installation
```bash
npm install @stdlib/assert-is-arguments
```
## Usage
```javascript
var isArguments = require( '@stdlib/assert-is-arguments' );
```
#### isArguments( value )
Tests if a `value` is an `arguments` object.
```javascript
function foo() {
return arguments;
}
var bool = isArguments( foo() );
// returns true
bool = isArguments( [] );
// returns false
```
## Examples
```javascript
var isArguments = require( '@stdlib/assert-is-arguments' );
function foo() {
return arguments;
}
var bool = isArguments( foo() );
// returns true
bool = isArguments( [] );
// returns false
bool = isArguments( {} );
// returns false
bool = isArguments( null );
// returns false
bool = isArguments( 'Arguments' );
// returns false
function Arguments() {
return this;
}
bool = isArguments( new Arguments() );
// returns false
```
* * *
## Notice
This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/assert-is-arguments.svg
[npm-url]: https://npmjs.org/package/@stdlib/assert-is-arguments
[test-image]: https://github.com/stdlib-js/assert-is-arguments/actions/workflows/test.yml/badge.svg
[test-url]: https://github.com/stdlib-js/assert-is-arguments/actions/workflows/test.yml
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/assert-is-arguments/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/assert-is-arguments?branch=main
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/assert-is-arguments/tree/deno
[umd-url]: https://github.com/stdlib-js/assert-is-arguments/tree/umd
[esm-url]: https://github.com/stdlib-js/assert-is-arguments/tree/esm
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://gitter.im/stdlib-js/stdlib/
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/assert-is-arguments/main/LICENSE