60 lines
1.7 KiB
JavaScript
60 lines
1.7 KiB
JavaScript
/**
|
|
* @license Apache-2.0
|
|
*
|
|
* Copyright (c) 2018 The Stdlib Authors.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
// MODULES //
|
|
|
|
var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
|
|
var Buffer = require( './../../ctor' );
|
|
|
|
|
|
// MAIN //
|
|
|
|
/**
|
|
* Allocates a buffer containing a provided string.
|
|
*
|
|
* @param {string} str - input string
|
|
* @param {string} [encoding="utf8"] - character encoding
|
|
* @throws {TypeError} first argument must be a string
|
|
* @throws {TypeError} second argument must be a string
|
|
* @throws {TypeError} second argument must be a valid encoding
|
|
* @returns {Buffer} new `Buffer` instance
|
|
*
|
|
* @example
|
|
* var buf = fromString( 'beep boop' );
|
|
* // returns <Buffer>
|
|
*/
|
|
function fromString( str, encoding ) {
|
|
if ( !isString( str ) ) {
|
|
throw new TypeError( 'invalid argument. First argument must be a string. Value: `' + str + '`' );
|
|
}
|
|
if ( arguments.length > 1 ) {
|
|
if ( !isString( encoding ) ) {
|
|
throw new TypeError( 'invalid argument. Second argument must be a string. Value: `' + encoding + '`' );
|
|
}
|
|
return new Buffer( str, encoding ); // eslint-disable-line no-buffer-constructor
|
|
}
|
|
return new Buffer( str, 'utf8' ); // eslint-disable-line no-buffer-constructor
|
|
}
|
|
|
|
|
|
// EXPORTS //
|
|
|
|
module.exports = fromString;
|