Package Exports

@stdlib/buffer-from-string
@stdlib/buffer-from-string/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/buffer-from-string) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

string2buffer

Allocate a buffer containing a provided string.

Installation

npm install @stdlib/buffer-from-string

Usage

var string2buffer = require( '@stdlib/buffer-from-string' );

string2buffer( str[, encoding] )

Allocates a buffer containing a provided string.

var buf = string2buffer( 'beep boop' );
// returns <Buffer>

The default character encoding is utf8. To specify an alternative encoding, provide an encoding argument.

var buf = string2buffer( '7468697320697320612074c3a97374', 'hex' );
// returns <Buffer>

The following encodings are supported:

utf8 (utf-8)
hex
binary
ascii
ucs2
base64

Examples

var randu = require( '@stdlib/random-base-randu' );
var randint = require( '@stdlib/random-base-discrete-uniform' );
var string2buffer = require( '@stdlib/buffer-from-string' );

// Create a buffer from a string:
var buf = string2buffer( 'beep boop bop' );
console.log( buf.toString() );

// Generate random strings...
var i;
var j;
for ( i = 0; i < 100; i++ ) {
    j = randint( 0, buf.length );
    if ( randu() < 2/buf.length ) {
        buf[ j ] = 32; // space
    } else {
        buf[ j ] = randint( 97, 122 );
    }
    console.log( buf.toString() );
}

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.

@stdlib/buffer-from-string