main.js (1680B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 // MODULES // 22 23 var isString = require( '@stdlib/assert/is-string' ).isPrimitive; 24 var Buffer = require( './../../ctor' ); 25 26 27 // MAIN // 28 29 /** 30 * Allocates a buffer containing a provided string. 31 * 32 * @param {string} str - input string 33 * @param {string} [encoding="utf8"] - character encoding 34 * @throws {TypeError} first argument must be a string 35 * @throws {TypeError} second argument must be a string 36 * @throws {TypeError} second argument must be a valid encoding 37 * @returns {Buffer} new `Buffer` instance 38 * 39 * @example 40 * var buf = fromString( 'beep boop' ); 41 * // returns <Buffer> 42 */ 43 function fromString( str, encoding ) { 44 if ( !isString( str ) ) { 45 throw new TypeError( 'invalid argument. First argument must be a string. Value: `' + str + '`' ); 46 } 47 if ( arguments.length > 1 ) { 48 if ( !isString( encoding ) ) { 49 throw new TypeError( 'invalid argument. Second argument must be a string. Value: `' + encoding + '`' ); 50 } 51 return Buffer.from( str, encoding ); 52 } 53 return Buffer.from( str, 'utf8' ); 54 } 55 56 57 // EXPORTS // 58 59 module.exports = fromString;