time-to-botec/js/node_modules/@stdlib/assert/is-buffer/README.md

isBuffer

Test if a value is a Buffer object.

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 Buffer objects.

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