10000 GitHub - stdlib-js/buffer-ctor at 9535068f39f36aba7497a8b1be52e7271cf6b66f
[go: up one dir, main page]

Skip to content

stdlib-js/buffer-ctor

Repository files navigation

Buffer

NPM version Build Status Coverage Status

Buffer constructor.

Installation

npm install @stdlib/buffer-ctor

Alternatively,

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

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


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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2023. The Stdlib Authors.

0