Test if a value is a Buffer object.
npm install @stdlib/assert-is-bufferAlternatively,
- To load the package in a website via a
scripttag without installation and bundlers, use the ES Module available on theesmbranch. - If you are using Deno, visit the
denobranch. - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umdbranch.
The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
var isBuffer = require( '@stdlib/assert-is-buffer' );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- The implementation supports both Node.js and browser polyfill
Bufferobjects.
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 falseThis 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.
See LICENSE.
Copyright © 2016-2023. The Stdlib Authors.
