$ npm install @stdlib/buffer-ctor
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
Buffer
Buffer constructor.
Installation
npm install @stdlib/buffer-ctor
Usage
var Buffer = require( '@stdlib/buffer-ctor' );
Buffer( size )
Allocates a Buffer having a specified number of bytes.
var b = new Buffer( 10 );
// returns <Buffer>
Buffer( array )
Allocates a Buffer from an array of octets.
var b = new Buffer( [ 1, 2, 3, 4 ] );
// returns <Buffer>[ 1, 2, 3, 4 ]
Buffer( buffer )
Copies buffer data to a new Buffer instance.
var b1 = new Buffer( [ 1, 2, 3, 4 ] );
var b2 = new Buffer( b1 );
// returns <Buffer>[ 1, 2, 3, 4 ]
Buffer( str[, encoding] )
Returns a Buffer containing a provided string.
var b = new Buffer( 'beep boop' );
// returns <Buffer>
Properties
TODO: add properties
Methods
TODO: add methods
Examples
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 );
See Also
@stdlib/array-buffer: ArrayBuffer.
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-2024. The Stdlib Authors.
Current Tags
- 0.2.2 ... latest (4 months ago)
stdlib-bot
kgryte
planeshifter
rreusser