extended-buffer 7.0.1 → 7.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 Sality
+Copyright (c) 2025 mvcbox
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,4 +1,4 @@
-[![npm version](https://badge.fury.io/js/extended-buffer.svg)](https://badge.fury.io/js/extended-buffer)
+[![npm version](https://badge.fury.io/js/extended-buffer.svg?flush_cache=v7_1_0)](https://badge.fury.io/js/extended-buffer)
 
 # ExtendedBuffer
 
@@ -56,20 +56,29 @@ const unread = b.nativeBufferView.subarray(b.pointer);
 
 ```ts
 type ExtendedBufferOptions = {
-  capacity?: number;      // initial native buffer size (bytes)
-  capacityStep?: number;  // how much to grow when resizing
+  capacity?: number;            // initial native buffer size (bytes)
+  capacityStep?: number;        // how much to grow when resizing
+  nativeAllocSlow?: boolean;    // using Buffer.allocUnsafeSlow() when initializing ExtendedBuffer
+  nativeReallocSlow?: boolean;  // using Buffer.allocUnsafeSlow() for further reallocations
 };
 ```
 
-Defaults (from source):
+Default values:
 
-- `capacity`: `512 * 1024` bytes (512 KiB)
+- `capacity`: `16 * 1024` bytes (16 KiB)
 - `capacityStep`: same as `capacity`
+- `nativeAllocSlow`: `false`
+- `nativeReallocSlow`: `false`
 
 Example:
 
 ```ts
-const b = new ExtendedBuffer({ capacity: 64 * 1024, capacityStep: 16 * 1024 });
+const b = new ExtendedBuffer({
+  capacity: 1024 * 1024,
+  capacityStep: 1024 * 1024,
+  nativeAllocSlow: true,
+  nativeReallocSlow: true
+});
 ```
 
 ---
@@ -137,7 +146,7 @@ if (b.isReadable(4)) {
 // Copy out as a native Buffer
 const chunk: Buffer = b.readBuffer(10, true);
 
-// Copy out as a new ExtendedBuffer (same capacity/capacityStep by default)
+// Copy out as a new ExtendedBuffer (same capacity/capacityStep/nativeAllocSlow/nativeReallocSlow by default)
 const eb: ExtendedBuffer = b.readBuffer(10);
 ```
 
@@ -232,11 +241,14 @@ The library defines these error classes:
 
 Common error codes you may see:
 
-- `SIZE_OUT_OF_RANGE` (reading more bytes than available)
-- `POINTER_OUT_OF_RANGE` (setting pointer outside `0…length`)
-- `INVALID_INTEGER_SIZE_VALUE_RANGE` (integer size not in `1…6`)
-- `EXCEEDING_MAXIMUM_BUFFER_SIZE` (allocation exceeds Node’s `kMaxLength`)
-- `INVALID_INSTANCE_STATE` (internal invariant check failed)
+- `SIZE_OUT_OF_RANGE`: reading more bytes than available
+- `POINTER_OUT_OF_RANGE`: setting pointer outside `0…length`
+- `INVALID_INTEGER_SIZE_VALUE_TYPE`: size is not a safe integer
+- `INVALID_INTEGER_SIZE_VALUE_RANGE`: integer size not in `1…6`
+- `INVALID_INSTANCE_STATE`: internal invariant check failed
+- `VALUE_MUST_BE_AN_INTEGER`: value not a safe integer
+- `VALUE_MUST_BE_AN_UNSIGNED_INTEGER`: value is not a safe integer or less than 0
+- `EXCEEDING_MAXIMUM_BUFFER_SIZE`: allocation exceeds Node’s `kMaxLength` or `os.totalmem()`
 
 ---
 

package/dist/ExtendedBuffer.d.ts

@@ -7,6 +7,8 @@ export declare class ExtendedBuffer {
     protected _nativeBuffer: Buffer;
     protected readonly _capacity: number;
     protected readonly _capacityStep: number;
+    protected readonly _nativeAllocSlow?: boolean;
+    protected readonly _nativeReallocSlow?: boolean;
     constructor(options?: ExtendedBufferOptions);
     protected createInstance(options?: ExtendedBufferOptions): this;
     get length(): number;

package/dist/ExtendedBuffer.js

@@ -1,14 +1,39 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExtendedBuffer = void 0;
 const buffer_1 = require("buffer");
-const utils = require("./utils");
+const utils = __importStar(require("./utils"));
 const errors_1 = require("./errors");
-const defaultCapacity = 512 * 1024;
+const defaultCapacity = 16 * 1024;
 const defaultCapacityStep = defaultCapacity;
 class ExtendedBuffer {
     constructor(options) {
         var _a, _b;
+        this._nativeAllocSlow = options === null || options === void 0 ? void 0 : options.nativeAllocSlow;
+        this._nativeReallocSlow = options === null || options === void 0 ? void 0 : options.nativeReallocSlow;
         this._capacity = (_a = options === null || options === void 0 ? void 0 : options.capacity) !== null && _a !== void 0 ? _a : defaultCapacity;
         this._capacityStep = (_b = options === null || options === void 0 ? void 0 : options.capacityStep) !== null && _b !== void 0 ? _b : defaultCapacityStep;
         utils.assertUnsignedInteger(this._capacity);
@@ -33,7 +58,7 @@ class ExtendedBuffer {
     }
     initExtendedBuffer() {
         this._pointer = 0;
-        this._nativeBuffer = utils.allocNativeBuffer(this._capacity);
+        this._nativeBuffer = utils.allocNativeBuffer(this._capacity, this._nativeAllocSlow);
         this._pointerStart = this._pointerEnd = Math.floor(this._capacity / 2);
         this.assertInstanceState();
         return this;
@@ -79,7 +104,7 @@ class ExtendedBuffer {
         }
         if (this.getWritableSize() < size) {
             const newSize = this._nativeBuffer.length + (size - this.getWritableSize()) + this._capacityStep;
-            this._nativeBuffer = utils.reallocNativeBuffer(this._nativeBuffer, newSize);
+            this._nativeBuffer = utils.reallocNativeBuffer(this._nativeBuffer, newSize, this._nativeReallocSlow);
         }
         const offset = Math.floor((this.getWritableSize() - size) / 2) + size - this._pointerStart;
         this._nativeBuffer.copy(this._nativeBuffer, this._pointerStart + offset, this._pointerStart, this._pointerEnd);
@@ -95,7 +120,7 @@ class ExtendedBuffer {
         }
         if (this.getWritableSize() < size) {
             const newSize = this._nativeBuffer.length + (size - this.getWritableSize()) + this._capacityStep;
-            this._nativeBuffer = utils.reallocNativeBuffer(this._nativeBuffer, newSize);
+            this._nativeBuffer = utils.reallocNativeBuffer(this._nativeBuffer, newSize, this._nativeReallocSlow);
         }
         const offset = this._nativeBuffer.length - Math.floor((this.getWritableSize() - size) / 2) - size - this._pointerEnd;
         this._nativeBuffer.copy(this._nativeBuffer, this._pointerStart + offset, this._pointerStart, this._pointerEnd);
@@ -127,7 +152,7 @@ class ExtendedBuffer {
             const reduceSize = freeSize - this._capacityStep;
             const newNativeSize = this._nativeBuffer.length - reduceSize;
             this.allocEnd(reduceSize);
-            this._nativeBuffer = utils.reallocNativeBuffer(this._nativeBuffer, newNativeSize);
+            this._nativeBuffer = utils.reallocNativeBuffer(this._nativeBuffer, newNativeSize, this._nativeReallocSlow);
         }
         return this;
     }
@@ -332,7 +357,9 @@ class ExtendedBuffer {
         else {
             bufferOptions = Object.assign({
                 capacity: this._capacity,
-                capacityStep: this._capacityStep
+                capacityStep: this._capacityStep,
+                nativeAllocSlow: this._nativeAllocSlow,
+                nativeReallocSlow: this._nativeReallocSlow
             }, bufferOptions !== null && bufferOptions !== void 0 ? bufferOptions : {});
             result = this.createInstance(bufferOptions).writeNativeBuffer(buffer);
         }

package/dist/ExtendedBufferOptions.d.ts

@@ -1,4 +1,6 @@
 export type ExtendedBufferOptions = {
     capacity?: number;
     capacityStep?: number;
+    nativeAllocSlow?: boolean;
+    nativeReallocSlow?: boolean;
 };

package/dist/errors/ExtendedBufferError.d.ts

@@ -1,2 +1,3 @@
 export declare class ExtendedBufferError extends Error {
+    constructor(message?: string);
 }

package/dist/errors/ExtendedBufferError.js

@@ -2,5 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExtendedBufferError = void 0;
 class ExtendedBufferError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = new.target.name;
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, new.target);
+        }
+    }
 }
 exports.ExtendedBufferError = ExtendedBufferError;

package/dist/utils/alloc-native-buffer.d.ts

@@ -1,2 +1,2 @@
 /// <reference types="node" />
-export declare function allocNativeBuffer(size: number): Buffer;
+export declare function allocNativeBuffer(size: number, allocSlow?: boolean): Buffer;

package/dist/utils/alloc-native-buffer.js

@@ -1,17 +1,40 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.allocNativeBuffer = void 0;
-const os = require("os");
+const os = __importStar(require("os"));
 const buffer_1 = require("buffer");
 const errors_1 = require("../errors");
 const assert_unsigned_integer_1 = require("./assert-unsigned-integer");
 const maxBufferSize = Math.min(buffer_1.kMaxLength, os.totalmem());
 (0, assert_unsigned_integer_1.assertUnsignedInteger)(maxBufferSize);
-function allocNativeBuffer(size) {
+function allocNativeBuffer(size, allocSlow) {
     (0, assert_unsigned_integer_1.assertUnsignedInteger)(size);
     if (size > maxBufferSize) {
         throw new errors_1.ExtendedBufferRangeError('EXCEEDING_MAXIMUM_BUFFER_SIZE');
     }
-    return buffer_1.Buffer.allocUnsafe(size);
+    return allocSlow ? buffer_1.Buffer.allocUnsafeSlow(size) : buffer_1.Buffer.allocUnsafe(size);
 }
 exports.allocNativeBuffer = allocNativeBuffer;

package/dist/utils/realloc-native-buffer.d.ts

@@ -1,2 +1,2 @@
 /// <reference types="node" />
-export declare function reallocNativeBuffer(buffer: Buffer, newSize: number): Buffer;
+export declare function reallocNativeBuffer(buffer: Buffer, newSize: number, allocSlow?: boolean): Buffer;

package/dist/utils/realloc-native-buffer.js

@@ -3,12 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.reallocNativeBuffer = void 0;
 const alloc_native_buffer_1 = require("./alloc-native-buffer");
 const assert_unsigned_integer_1 = require("./assert-unsigned-integer");
-function reallocNativeBuffer(buffer, newSize) {
+function reallocNativeBuffer(buffer, newSize, allocSlow) {
     (0, assert_unsigned_integer_1.assertUnsignedInteger)(newSize);
     if (buffer.length === newSize) {
         return buffer;
     }
-    const newBuffer = (0, alloc_native_buffer_1.allocNativeBuffer)(newSize);
+    const newBuffer = (0, alloc_native_buffer_1.allocNativeBuffer)(newSize, allocSlow);
     buffer.copy(newBuffer, 0, 0, Math.min(buffer.length, newBuffer.length));
     return newBuffer;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "extended-buffer",
-  "version": "7.0.1",
+  "version": "7.1.0",
   "description": "Node JS extended Buffer",
   "type": "commonjs",
   "main": "./dist/index.js",
@@ -9,12 +9,13 @@
     ".": {
       "types": "./dist/index.d.ts",
       "require": "./dist/index.js",
+      "import": "./dist/index.js",
       "default": "./dist/index.js"
     }
   },
   "scripts": {
     "build": "npm run clean && node ./node_modules/.bin/tsc",
-    "test": "npm run build && node ./node_modules/.bin/mocha",
+    "test": "node ./node_modules/.bin/mocha",
     "coverage": "node ./node_modules/.bin/nyc --reporter=html --reporter=text ./node_modules/.bin/mocha",
     "clean": "node -e \"['./dist', './coverage', './.nyc_output'].forEach(item => require('fs').rmSync(item, {recursive:true,force:true}));\"",
     "prepack": "npm run build"
@@ -55,9 +56,9 @@
   ],
   "devDependencies": {
     "@types/node": "^6.14.13",
-    "chai": "^4.1.2",
-    "mocha": "^4.0.1",
-    "nyc": "^11.3.0",
+    "chai": "^4.5.0",
+    "mocha": "^6.2.3",
+    "nyc": "^11.9.0",
     "typescript": "^4.7.2"
   }
 }