@stdlib/assert-is-buffer

What is @stdlib/assert-is-buffer?

The @stdlib/assert-is-buffer package is a utility for checking if a value is a Buffer object. It provides a simple and efficient way to validate whether a given input is a Buffer, which is useful in various scenarios such as data processing, network communication, and file handling.

What are @stdlib/assert-is-buffer's main functionalities?

Check if a value is a Buffer

This feature allows you to check if a given value is a Buffer object. The function returns true if the value is a Buffer and false otherwise.

const isBuffer = require('@stdlib/assert-is-buffer');

const buf = Buffer.from('hello');
const notBuf = 'hello';

console.log(isBuffer(buf)); // true
console.log(isBuffer(notBuf)); // false

Other packages similar to @stdlib/assert-is-buffer

is-buffer

The is-buffer package is a simple utility to check if a value is a Buffer object. It provides similar functionality to @stdlib/assert-is-buffer by offering a straightforward method to determine if a value is a Buffer. Both packages are lightweight and serve the same primary purpose, but @stdlib/assert-is-buffer is part of the larger @stdlib library, which offers a wide range of utilities and mathematical functions.

buffer-equal

The buffer-equal package is used to compare two Buffer objects for equality. While it does not directly check if a value is a Buffer, it is often used in conjunction with buffer validation utilities like @stdlib/assert-is-buffer. This package is useful when you need to ensure that two Buffer objects contain the same data.

README

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 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

---

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-2021. The Stdlib Authors.

Changelog

0.0.6 (2021-07-09)

No changes reported for this release.

</section> <!-- /.release --> <section class="release" id="v0.0.5">