@stdlib/assert-has-node-buffer-support

What is @stdlib/assert-has-node-buffer-support?

@stdlib/assert-has-node-buffer-support is a package that provides a utility to check if the current environment supports Node.js Buffer objects. This can be useful for ensuring compatibility and functionality in environments where Buffer support is required.

What are @stdlib/assert-has-node-buffer-support's main functionalities?

Check Buffer Support

This feature allows you to check if the current environment supports Node.js Buffer objects. The function returns a boolean value indicating the presence of Buffer support.

const hasBufferSupport = require('@stdlib/assert-has-node-buffer-support');

if (hasBufferSupport()) {
  console.log('Buffer support is available.');
} else {
  console.log('Buffer support is not available.');
}

Other packages similar to @stdlib/assert-has-node-buffer-support

buffer

The 'buffer' package is a Node.js core module that provides a way to handle binary data. While it does not specifically check for Buffer support, it is the primary package used for working with Buffer objects in Node.js. It is more comprehensive in terms of functionality for handling binary data compared to @stdlib/assert-has-node-buffer-support.

is-buffer

The 'is-buffer' package is a simple utility to check if a given object is a Buffer. Unlike @stdlib/assert-has-node-buffer-support, which checks for the environment's support for Buffer objects, 'is-buffer' checks if a specific object is an instance of Buffer. It is useful for type-checking in applications that handle binary data.

README

Node.js Buffer Support

Detect native Buffer support.

Installation

npm install @stdlib/assert-has-node-buffer-support

Usage

var hasNodeBufferSupport = require( '@stdlib/assert-has-node-buffer-support' );

hasNodeBufferSupport()

Detects if a runtime environment supports Buffer.

var bool = hasNodeBufferSupport();
// returns <boolean>

Examples

var hasNodeBufferSupport = require( '@stdlib/assert-has-node-buffer-support' );

var bool = hasNodeBufferSupport();
if ( bool ) {
    console.log( 'Environment has Buffer support.' );
} else {
    console.log( 'Environment lacks Buffer support.' );
}

CLI

Installation

To use the module as a general utility, install the module globally

npm install -g @stdlib/assert-has-node-buffer-support

Usage

Usage: has-node-buffer-support [options]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.

Examples

$ has-node-buffer-support
<boolean>

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.

License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.

Changelog

0.0.1 (2021-06-14)

No changes reported for this release.

</section> <!-- /.release -->