# isBuffer
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Test if a value is a [Buffer][node-buffer] object.
## Installation
```bash
npm install @stdlib/assert-is-buffer
```
## Usage
```javascript
var isBuffer = require( '@stdlib/assert-is-buffer' );
```
#### isBuffer( value )
Tests if a `value` is a [`Buffer`][node-buffer] object.
```javascript
var Buffer = require( '@stdlib/buffer-ctor' );
var value = new Buffer( [ 1, 2, 3, 4 ] );
var bool = isBuffer( value );
// returns true
```
## Notes
- The implementation supports both [Node.js][node-buffer] and [browser polyfill][browser-buffer] `Buffer` objects.
## Examples
```javascript
var Int8Array = require( '@stdlib/array-int8' );
var Buffer = require( '@stdlib/buffer-ctor' );
var isBuffer = require( '@stdlib/assert-is-buffer' );
var bool = isBuffer( new Buffer( [ 1, 2, 3, 4 ] ) );
// returns true
bool = isBuffer( new Buffer( 'beep' ) );
// returns true
bool = isBuffer( [] );
// returns false
bool = isBuffer( {} );
// returns false
bool = isBuffer( new Int8Array() );
// returns false
bool = isBuffer( function foo() {} );
// returns false
bool = isBuffer( null );
// returns false
bool = isBuffer( void 0 );
// returns false
bool = isBuffer( 'beep' );
// returns false
bool = isBuffer( 5 );
// 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-buffer.svg
[npm-url]: https://npmjs.org/package/@stdlib/assert-is-buffer
[test-image]: https://github.com/stdlib-js/assert-is-buffer/actions/workflows/test.yml/badge.svg
[test-url]: https://github.com/stdlib-js/assert-is-buffer/actions/workflows/test.yml
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/assert-is-buffer/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/assert-is-buffer?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-buffer/tree/deno
[umd-url]: https://github.com/stdlib-js/assert-is-buffer/tree/umd
[esm-url]: https://github.com/stdlib-js/assert-is-buffer/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-buffer/main/LICENSE
[node-buffer]: http://nodejs.org/api/buffer.html
[browser-buffer]: https://github.com/feross/buffer