main.js (1389B)
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 isBuffer = require( '@stdlib/assert/is-buffer' ); 24 var Buffer = require( './../../ctor' ); 25 26 27 // MAIN // 28 29 /** 30 * Copies buffer data to a new `Buffer` instance. 31 * 32 * @param {Buffer} buffer - buffer from which to copy 33 * @throws {TypeError} must provide a `Buffer` instance 34 * @returns {Buffer} new `Buffer` instance 35 * 36 * @example 37 * var fromArray = require( '@stdlib/buffer/from-array' ); 38 * 39 * var b1 = fromArray( [ 1, 2, 3, 4 ] ); 40 * // returns <Buffer> 41 * 42 * var b2 = fromBuffer( b1 ); 43 * // returns <Buffer> 44 */ 45 function fromBuffer( buffer ) { 46 if ( !isBuffer( buffer ) ) { 47 throw new TypeError( 'invalid argument. Must provide a Buffer. Value: `' + buffer + '`' ); 48 } 49 return Buffer.from( buffer ); 50 } 51 52 53 // EXPORTS // 54 55 module.exports = fromBuffer;