# string2buffer [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] > Allocate a [buffer][@stdlib/buffer/ctor] containing a provided string.
## Installation ```bash npm install @stdlib/buffer-from-string ```
## Usage ```javascript var string2buffer = require( '@stdlib/buffer-from-string' ); ``` #### string2buffer( str\[, encoding] ) Allocates a [buffer][@stdlib/buffer/ctor] containing a provided `string`. ```javascript var buf = string2buffer( 'beep boop' ); // returns ``` The default character encoding is `utf8`. To specify an alternative encoding, provide an `encoding` argument. ```javascript var buf = string2buffer( '7468697320697320612074c3a97374', 'hex' ); // returns ``` The following `encodings` are supported: - `utf8` (`utf-8`) - `hex` - `binary` - `ascii` - `ucs2` - `base64`
## Examples ```javascript 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][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].