time-to-botec/squiggle/node_modules/@stdlib/buffer/alloc-unsafe/README.md
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

2.8 KiB

alloc

Allocate a buffer having a specified number of bytes.

Usage

var allocUnsafe = require( '@stdlib/buffer/alloc-unsafe' );

allocUnsafe( size )

Unsafely allocates a buffer having a specified number of bytes.

var buf = allocUnsafe( 10 );
// returns <Buffer>

Notes

  • The underlying memory of returned Buffer instances is not initialized. Memory contents are unknown and may contain sensitive data.
  • When the size is less than half the pool size (specified on the Buffer constructor in modern Node.js environments), memory is allocated from the Buffer pool for faster allocation of new Buffer instances.

Examples

var allocUnsafe = require( '@stdlib/buffer/alloc-unsafe' );

var buf;
var i;

// Repeatedly unsafely allocate memory and inspect the buffer contents...
for ( i = 0; i < 100; i++ ) {
    buf = allocUnsafe( 100 );
    console.log( buf.toString() );
}