# Buffer

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]

> Buffer namespace.

## Installation

```bash
npm install @stdlib/buffer
```


## Usage

```javascript
var ns = require( '@stdlib/buffer' );
```

#### ns

Buffer namespace.

```javascript
var o = ns;
// returns {...}
```

The namespace contains the following:

-   [`allocUnsafe( size )`][@stdlib/buffer/alloc-unsafe]: allocate a buffer having a specified number of bytes.
-   [`Buffer()`][@stdlib/buffer/ctor]: buffer constructor.
-   [`arraybuffer2buffer( buf[, byteOffset[, length]] )`][@stdlib/buffer/from-arraybuffer]: allocate a buffer from an ArrayBuffer.
-   [`copyBuffer( buffer )`][@stdlib/buffer/from-buffer]: copy buffer data to a new `Buffer` instance.
-   [`string2buffer( str[, encoding] )`][@stdlib/buffer/from-string]: allocate a buffer containing a provided string.
-   [`reviver( key, value )`][@stdlib/buffer/reviver]: revive a JSON-serialized Buffer.
-   [`toJSON( buffer )`][@stdlib/buffer/to-json]: return a JSON representation of a Buffer.

## Examples

```javascript
var objectKeys = require( '@stdlib/utils/keys' );
var ns = require( '@stdlib/buffer' );

console.log( objectKeys( ns ) );
```


* * *

## Notice

This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].

#### Community

[![Chat][chat-image]][chat-url]

---

## License

See [LICENSE][stdlib-license].

## Copyright

Copyright © 2016-2021. The Stdlib [Authors][stdlib-authors].

[npm-image]: http://img.shields.io/npm/v/@stdlib/buffer.svg
[npm-url]: https://npmjs.org/package/@stdlib/buffer

[test-image]: https://github.com/stdlib-js/buffer/actions/workflows/test.yml/badge.svg
[test-url]: https://github.com/stdlib-js/buffer/actions/workflows/test.yml

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/buffer/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/buffer?branch=main

[dependencies-image]: https://img.shields.io/david/stdlib-js/buffer.svg
[dependencies-url]: https://david-dm.org/stdlib-js/buffer/main

[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://gitter.im/stdlib-js/stdlib/

[stdlib]: https://github.com/stdlib-js/stdlib

[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/buffer/main/LICENSE

[@stdlib/buffer/alloc-unsafe]: https://github.com/stdlib-js/buffer/tree/main/alloc-unsafe

[@stdlib/buffer/ctor]: https://github.com/stdlib-js/buffer/tree/main/ctor

[@stdlib/buffer/from-arraybuffer]: https://github.com/stdlib-js/buffer/tree/main/from-arraybuffer

[@stdlib/buffer/from-buffer]: https://github.com/stdlib-js/buffer/tree/main/from-buffer

[@stdlib/buffer/from-string]: https://github.com/stdlib-js/buffer/tree/main/from-string

[@stdlib/buffer/reviver]: https://github.com/stdlib-js/buffer/tree/main/reviver

[@stdlib/buffer/to-json]: https://github.com/stdlib-js/buffer/tree/main/to-json

