main.js (1681B)
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 isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ); 24 var Buffer = require( './../../ctor' ); 25 26 27 // MAIN // 28 29 /** 30 * Allocates a buffer having a specified number of bytes. 31 * 32 * ## Notes 33 * 34 * - The underlying memory of returned `Buffer` instances is not initialized. Memory contents are unknown and may contain sensitive data. 35 * - When the size is less than half the pool size (specified on the `Buffer` constructor), memory is allocated from the `Buffer` pool for faster allocation of new `Buffer` instances. 36 * 37 * 38 * @param {NonNegativeInteger} size - number of bytes to allocate 39 * @throws {TypeError} must provide a nonnegative integer 40 * @returns {Buffer} new `Buffer` instance 41 * 42 * @example 43 * var buf = allocUnsafe( 10 ); 44 * // returns <Buffer> 45 */ 46 function allocUnsafe( size ) { 47 if ( !isNonNegativeInteger( size ) ) { 48 throw new TypeError( 'invalid argument. Must provide a nonnegative integer. Value: `' + size + '`' ); 49 } 50 return Buffer.allocUnsafe( size ); 51 } 52 53 54 // EXPORTS // 55 56 module.exports = allocUnsafe;