Rename variable

Author: kgryte

lib/node_modules/@stdlib/buffer/from-string/README.md

@@ -1,4 +1,4 @@
-# fromString
+# string2buffer
 
 > Allocate a [buffer][@stdlib/buffer/ctor] containing a provided string.
 
@@ -17,22 +17,22 @@
 ## Usage
 
 ```javascript
-var fromString = require( '@stdlib/buffer/from-string' );
+var string2buffer = require( '@stdlib/buffer/from-string' );
 ```
 
-#### fromString( str\[, encoding] )
+#### string2buffer( str\[, encoding] )
 
 Allocates a [buffer][@stdlib/buffer/ctor] containing a provided `string`.
 
 ```javascript
-var buf = fromString( 'beep boop' );
+var buf = string2buffer( 'beep boop' );
 // returns <Buffer>
 ```
 
 The default character encoding is `utf8`. To specify an alternative encoding, provide an `encoding` argument.
 
 ```javascript
-var buf = fromString( '7468697320697320612074c3a97374', 'hex' );
+var buf = string2buffer( '7468697320697320612074c3a97374', 'hex' );
 // returns <Buffer>
 ```
 
@@ -70,10 +70,10 @@ The following `encodings` are supported:
 ```javascript
 var randu = require( '@stdlib/random/base/randu' );
 var randint = require( '@stdlib/random/base/discrete-uniform' );
-var fromString = require( '@stdlib/buffer/from-string' );
+var string2buffer = require( '@stdlib/buffer/from-string' );
 
 // Create a buffer from a string:
-var buf = fromString( 'beep boop bop' );
+var buf = string2buffer( 'beep boop bop' );
 console.log( buf.toString() );
 
 // Generate random strings...

lib/node_modules/@stdlib/buffer/from-string/benchmark/benchmark.js

@@ -5,7 +5,7 @@
 var bench = require( '@stdlib/bench' );
 var isBuffer = require( '@stdlib/assert/is-buffer' );
 var pkg = require( './../package.json' ).name;
-var fromString = require( './../lib' );
+var string2buffer = require( './../lib' );
 
 
 // MAIN //
@@ -28,7 +28,7 @@ bench( pkg, function benchmark( b ) {
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
 		str = values[ i%values.length ];
-		out = fromString( str );
+		out = string2buffer( str );
 		if ( out.length <= 0 ) {
 			b.fail( 'should have a length greater than 0' );
 		}
@@ -59,7 +59,7 @@ bench( pkg+':encoding=utf8', function benchmark( b ) {
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
 		str = values[ i%values.length ];
-		out = fromString( str );
+		out = string2buffer( str );
 		if ( out.length <= 0 ) {
 			b.fail( 'should have a length greater than 0' );
 		}
@@ -88,7 +88,7 @@ bench( pkg+':encoding=hex', function benchmark( b ) {
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
 		str = values[ i%values.length ];
-		out = fromString( str, 'hex' );
+		out = string2buffer( str, 'hex' );
 		if ( out.length <= 0 ) {
 			b.fail( 'should have a length greater than 0' );
 		}

lib/node_modules/@stdlib/buffer/from-string/benchmark/benchmark.length.js

@@ -6,7 +6,7 @@ var bench = require( '@stdlib/bench' );
 var pow = require( '@stdlib/math/base/special/pow' );
 var isBuffer = require( '@stdlib/assert/is-buffer' );
 var pkg = require( './../package.json' ).name;
-var fromString = require( './../lib' );
+var string2buffer = require( './../lib' );
 
 
 // FUNCTIONS //
@@ -40,7 +40,7 @@ function createBenchmark( len ) {
 
 		b.tic();
 		for ( i = 0; i < b.iterations; i++ ) {
-			out = fromString( str );
+			out = string2buffer( str );
 			if ( out.length <= 0 ) {
 				b.fail( 'unexpected length' );
 			}

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

@@ -2,10 +2,10 @@
 
 var randu = require( '@stdlib/random/base/randu' );
 var randint = require( '@stdlib/random/base/discrete-uniform' );
-var fromString = require( './../lib' );
+var string2buffer = require( './../lib' );
 
 // Create a buffer from a string:
-var buf = fromString( 'beep boop bop' );
+var buf = string2buffer( 'beep boop bop' );
 console.log( buf.toString() );
 
 // Generate random strings...

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

@@ -6,9 +6,9 @@
 * @module @stdlib/buffer/from-string
 *
 * @example
-* var fromString = require( '@stdlib/buffer/from-string' );
+* var string2buffer = require( '@stdlib/buffer/from-string' );
 *
-* var buf = fromString( 'beep boop' );
+* var buf = string2buffer( 'beep boop' );
 * // returns <Buffer>
 */
 
@@ -19,14 +19,14 @@ var hasFrom = require( './has_from.js' );
 
 // MAIN //
 
-var fromString;
+var string2buffer;
 if ( hasFrom ) {
-	fromString = require( './main.js' );
+	string2buffer = require( './main.js' );
 } else {
-	fromString = require( './polyfill.js' );
+	string2buffer = require( './polyfill.js' );
 }
 
 
 // EXPORTS //
 
-module.exports = fromString;
+module.exports = string2buffer;

lib/node_modules/@stdlib/buffer/from-string/test/test.js

@@ -7,30 +7,30 @@ var proxyquire = require( 'proxyquire' );
 var isBuffer = require( '@stdlib/assert/is-buffer' );
 var polyfill = require( './../lib/polyfill.js' );
 var nonPolyfill = require( './../lib/main.js' );
-var fromString = require( './../lib' );
+var string2buffer = require( './../lib' );
 
 
 // TESTS //
 
 tape( 'main export is a function', function test( t ) {
 	t.ok( true, __filename );
-	t.strictEqual( typeof fromString, 'function', 'main export is a function' );
+	t.strictEqual( typeof string2buffer, 'function', 'main export is a function' );
 	t.end();
 });
 
 tape( 'in older environments, the main export is a polyfill', function test( t ) {
-	var fromString = proxyquire( './../lib', {
+	var string2buffer = proxyquire( './../lib', {
 		'./has_from.js': false
 	});
-	t.strictEqual( fromString, polyfill, 'returns polyfill' );
+	t.strictEqual( string2buffer, polyfill, 'returns polyfill' );
 	t.end();
 });
 
 tape( 'in newer environments, the main export is not a polyfill', function test( t ) {
-	var fromString = proxyquire( './../lib', {
+	var string2buffer = proxyquire( './../lib', {
 		'./has_from.js': true
 	});
-	t.strictEqual( fromString, nonPolyfill, 'does not return polyfill' );
+	t.strictEqual( string2buffer, nonPolyfill, 'does not return polyfill' );
 	t.end();
 });
 
@@ -58,7 +58,7 @@ tape( 'the function throws an error if not provided a string', function test( t
 
 	function badValue( value ) {
 		return function badValue() {
-			fromString( value );
+			string2buffer( value );
 		};
 	}
 });
@@ -87,7 +87,7 @@ tape( 'the function throws an error if not provided a string (encoding)', functi
 
 	function badValue( value ) {
 		return function badValue() {
-			fromString( value, 'utf8' );
+			string2buffer( value, 'utf8' );
 		};
 	}
 });
@@ -119,21 +119,21 @@ tape( 'the function throws an error if not provided a valid encoding argument',
 
 	function badValue( value ) {
 		return function badValue() {
-			fromString( 'beep', value );
+			string2buffer( 'beep', value );
 		};
 	}
 });
 
 tape( 'the function allocates a buffer containing a provided string', function test( t ) {
-	var buf = fromString( 'beep boop' );
+	var buf = string2buffer( 'beep boop' );
 	t.strictEqual( isBuffer( buf ), true, 'returns a buffer' );
 	t.strictEqual( buf.length, 9, 'has expected length' );
 	t.strictEqual( buf.toString(), 'beep boop', 'returns expected value' );
 	t.end();
 });
 
 tape( 'the function allocates a buffer containing a provided string (encoding)', function test( t ) {
-	var buf = fromString( '7468697320697320612074c3a97374', 'hex' );
+	var buf = string2buffer( '7468697320697320612074c3a97374', 'hex' );
 	t.strictEqual( isBuffer( buf ), true, 'returns a buffer' );
 	t.strictEqual( buf.length, 15, 'has expected length' );
 	t.strictEqual( buf.toString(), 'this is a tést', 'returns expected value' );

lib/node_modules/@stdlib/buffer/from-string/test/test.main.js

@@ -6,7 +6,7 @@ var tape = require( 'tape' );
 var isBuffer = require( '@stdlib/assert/is-buffer' );
 var isFunction = require( '@stdlib/assert/is-function' );
 var Buffer = require( '@stdlib/buffer/ctor' );
-var fromString = require( './../lib/main.js' );
+var string2buffer = require( './../lib/main.js' );
 
 
 // VARIABLES //
@@ -20,7 +20,7 @@ var opts = {
 
 tape( 'main export is a function', function test( t ) {
 	t.ok( true, __filename );
-	t.strictEqual( typeof fromString, 'function', 'main export is a function' );
+	t.strictEqual( typeof string2buffer, 'function', 'main export is a function' );
 	t.end();
 });
 
@@ -48,7 +48,7 @@ tape( 'the function throws an error if not provided a string', function test( t
 
 	function badValue( value ) {
 		return function badValue() {
-			fromString( value );
+			string2buffer( value );
 		};
 	}
 });
@@ -77,7 +77,7 @@ tape( 'the function throws an error if not provided a string (encoding)', functi
 
 	function badValue( value ) {
 		return function badValue() {
-			fromString( value, 'utf8' );
+			string2buffer( value, 'utf8' );
 		};
 	}
 });
@@ -109,21 +109,21 @@ tape( 'the function throws an error if not provided a valid encoding argument',
 
 	function badValue( value ) {
 		return function badValue() {
-			fromString( 'beep', value );
+			string2buffer( 'beep', value );
 		};
 	}
 });
 
 tape( 'the function allocates a buffer containing a provided string', opts, function test( t ) {
-	var buf = fromString( 'beep boop' );
+	var buf = string2buffer( 'beep boop' );
 	t.strictEqual( isBuffer( buf ), true, 'returns a buffer' );
 	t.strictEqual( buf.length, 9, 'has expected length' );
 	t.strictEqual( buf.toString(), 'beep boop', 'returns expected value' );
 	t.end();
 });
 
 tape( 'the function allocates a buffer containing a provided string (encoding)', opts, function test( t ) {
-	var buf = fromString( '7468697320697320612074c3a97374', 'hex' );
+	var buf = string2buffer( '7468697320697320612074c3a97374', 'hex' );
 	t.strictEqual( isBuffer( buf ), true, 'returns a buffer' );
 	t.strictEqual( buf.length, 15, 'has expected length' );
 	t.strictEqual( buf.toString(), 'this is a tést', 'returns expected value' );

lib/node_modules/@stdlib/buffer/from-string/test/test.polyfill.js

@@ -4,14 +4,14 @@
 
 var tape = require( 'tape' );
 var isBuffer = require( '@stdlib/assert/is-buffer' );
-var fromString = require( './../lib/polyfill.js' );
+var string2buffer = require( './../lib/polyfill.js' );
 
 
 // TESTS //
 
 tape( 'main export is a function', function test( t ) {
 	t.ok( true, __filename );
-	t.strictEqual( typeof fromString, 'function', 'main export is a function' );
+	t.strictEqual( typeof string2buffer, 'function', 'main export is a function' );
 	t.end();
 });
 
@@ -39,7 +39,7 @@ tape( 'the function throws an error if not provided a string', function test( t
 
 	function badValue( value ) {
 		return function badValue() {
-			fromString( value );
+			string2buffer( value );
 		};
 	}
 });
@@ -68,7 +68,7 @@ tape( 'the function throws an error if not provided a string (encoding)', functi
 
 	function badValue( value ) {
 		return function badValue() {
-			fromString( value, 'utf8' );
+			string2buffer( value, 'utf8' );
 		};
 	}
 });
@@ -100,21 +100,21 @@ tape( 'the function throws an error if not provided a valid encoding argument',
 
 	function badValue( value ) {
 		return function badValue() {
-			fromString( 'beep', value );
+			string2buffer( 'beep', value );
 		};
 	}
 });
 
 tape( 'the function allocates a buffer containing a provided string', function test( t ) {
-	var buf = fromString( 'beep boop' );
+	var buf = string2buffer( 'beep boop' );
 	t.strictEqual( isBuffer( buf ), true, 'returns a buffer' );
 	t.strictEqual( buf.length, 9, 'has expected length' );
 	t.strictEqual( buf.toString(), 'beep boop', 'returns expected value' );
 	t.end();
 });
 
 tape( 'the function allocates a buffer containing a provided string (encoding)', function test( t ) {
-	var buf = fromString( '7468697320697320612074c3a97374', 'hex' );
+	var buf = string2buffer( '7468697320697320612074c3a97374', 'hex' );
 	t.strictEqual( isBuffer( buf ), true, 'returns a buffer' );
 	t.strictEqual( buf.length, 15, 'has expected length' );
 	t.strictEqual( buf.toString(), 'this is a tést', 'returns expected value' );