$ npm install @stdlib/assert-is-buffer
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
isBuffer
Test if a value is a Buffer object.
Installation
npm install @stdlib/assert-is-buffer
Usage
var isBuffer = require( '@stdlib/assert-is-buffer' );
isBuffer( value )
Tests if a value is a Buffer object.
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 and browser polyfill
Bufferobjects.
Examples
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, 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, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.
Current Tags
- 0.2.2 ... latest (4 months ago)
stdlib-bot
kgryte
planeshifter
rreusser