# Buffer
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> [Buffer][node-buffer] constructor.
## Installation
```bash
npm install @stdlib/buffer-ctor
```
## Usage
```javascript
var Buffer = require( '@stdlib/buffer-ctor' );
```
#### Buffer( size )
Allocates a [`Buffer`][node-buffer] having a specified number of bytes.
```javascript
var b = new Buffer( 10 );
// returns
```
#### Buffer( array )
Allocates a [`Buffer`][node-buffer] from an array of octets.
```javascript
var b = new Buffer( [ 1, 2, 3, 4 ] );
// returns [ 1, 2, 3, 4 ]
```
#### Buffer( buffer )
Copies [buffer][node-buffer] data to a new [`Buffer`][node-buffer] instance.
```javascript
var b1 = new Buffer( [ 1, 2, 3, 4 ] );
var b2 = new Buffer( b1 );
// returns [ 1, 2, 3, 4 ]
```
#### Buffer( str\[, encoding] )
Returns a [`Buffer`][node-buffer] containing a provided `string`.
```javascript
var b = new Buffer( 'beep boop' );
// returns
```
* * *
### Properties
TODO: add properties
* * *
### Methods
TODO: add methods
* * *
## Examples
```javascript
var ctor = require( '@stdlib/buffer-ctor' );
var b;
var i;
// Allocate uninitialized memory:
if ( typeof ctor.alloc === 'function' ) {
b = ctor.alloc( 10 );
} else {
b = new ctor( 10 );
}
// Zero fill the buffer...
for ( i = 0; i < b.length; i++ ) {
b[ i ] = 0;
}
console.log( b );
```
* * *
## 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-2022. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/buffer-ctor.svg
[npm-url]: https://npmjs.org/package/@stdlib/buffer-ctor
[test-image]: https://github.com/stdlib-js/buffer-ctor/actions/workflows/test.yml/badge.svg
[test-url]: https://github.com/stdlib-js/buffer-ctor/actions/workflows/test.yml
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/buffer-ctor/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/buffer-ctor?branch=main
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/buffer-ctor/tree/deno
[umd-url]: https://github.com/stdlib-js/buffer-ctor/tree/umd
[esm-url]: https://github.com/stdlib-js/buffer-ctor/tree/esm
[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-ctor/main/LICENSE
[node-buffer]: https://nodejs.org/api/buffer.html
[@stdlib/array/buffer]: https://www.npmjs.com/package/@stdlib/array-buffer