@naturalcycles/js-lib 15.94.1 → 15.95.0

package/dist/buffer/buffer.util.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Returns an ArrayBuffer that contains exactly the bytes of the given view (e.g Uint8Array or Buffer).
+ *
+ * Safe alternative to `view.buffer`, which returns the whole underlying ArrayBuffer.
+ * It can be larger than the view, and the view may start at a non-zero offset:
+ * e.g Node.js allocates small Buffers from a shared pool (`Buffer.from(string)`,
+ * `fs.readFileSync` of small files), or the view was created with `subarray()`.
+ *
+ * Zero-copy when the view covers the whole ArrayBuffer, otherwise copies exactly its bytes.
+ */
+export declare function _toArrayBuffer<T extends ArrayBufferLike>(view: ArrayBufferView<T>): T;
+/**
+ * Same as _chunk, but for Uint8Array (or Buffer).
+ * Chunks are zero-copy views (subarray) into the input, and preserve its type
+ * (e.g Buffer in - Buffer[] out).
+ */
+export declare function _chunkBuffer<T extends Uint8Array>(buf: T, size: number): T[];

package/dist/buffer/buffer.util.js

@@ -0,0 +1,29 @@
+/**
+ * Returns an ArrayBuffer that contains exactly the bytes of the given view (e.g Uint8Array or Buffer).
+ *
+ * Safe alternative to `view.buffer`, which returns the whole underlying ArrayBuffer.
+ * It can be larger than the view, and the view may start at a non-zero offset:
+ * e.g Node.js allocates small Buffers from a shared pool (`Buffer.from(string)`,
+ * `fs.readFileSync` of small files), or the view was created with `subarray()`.
+ *
+ * Zero-copy when the view covers the whole ArrayBuffer, otherwise copies exactly its bytes.
+ */
+export function _toArrayBuffer(view) {
+    const { buffer, byteOffset, byteLength } = view;
+    if (byteOffset === 0 && byteLength === buffer.byteLength)
+        return buffer;
+    return buffer.slice(byteOffset, byteOffset + byteLength);
+}
+/**
+ * Same as _chunk, but for Uint8Array (or Buffer).
+ * Chunks are zero-copy views (subarray) into the input, and preserve its type
+ * (e.g Buffer in - Buffer[] out).
+ */
+export function _chunkBuffer(buf, size) {
+    const out = [];
+    for (let i = 0; i < buf.length; i += size) {
+        // subarray preserves the subclass at runtime (Buffer#subarray returns a Buffer)
+        out.push(buf.subarray(i, i + size));
+    }
+    return out;
+}

package/dist/buffer/index.d.ts

@@ -0,0 +1 @@
+export * from './buffer.util.js';

package/dist/buffer/index.js

@@ -0,0 +1 @@
+export * from './buffer.util.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/js-lib",
   "type": "module",
-  "version": "15.94.1",
+  "version": "15.95.0",
   "dependencies": {
     "tslib": "^2"
   },
@@ -28,6 +28,8 @@
     "./array/*.js": "./dist/array/*.js",
     "./browser": "./dist/browser/index.js",
     "./browser/*.js": "./dist/browser/*.js",
+    "./buffer": "./dist/buffer/index.js",
+    "./buffer/*.js": "./dist/buffer/*.js",
     "./datetime": "./dist/datetime/index.js",
     "./datetime/*.js": "./dist/datetime/*.js",
     "./decorators": "./dist/decorators/index.js",

package/src/buffer/buffer.util.ts

@@ -0,0 +1,31 @@
+/**
+ * Returns an ArrayBuffer that contains exactly the bytes of the given view (e.g Uint8Array or Buffer).
+ *
+ * Safe alternative to `view.buffer`, which returns the whole underlying ArrayBuffer.
+ * It can be larger than the view, and the view may start at a non-zero offset:
+ * e.g Node.js allocates small Buffers from a shared pool (`Buffer.from(string)`,
+ * `fs.readFileSync` of small files), or the view was created with `subarray()`.
+ *
+ * Zero-copy when the view covers the whole ArrayBuffer, otherwise copies exactly its bytes.
+ */
+export function _toArrayBuffer<T extends ArrayBufferLike>(view: ArrayBufferView<T>): T {
+  const { buffer, byteOffset, byteLength } = view
+  if (byteOffset === 0 && byteLength === buffer.byteLength) return buffer
+  return buffer.slice(byteOffset, byteOffset + byteLength) as T
+}
+
+/**
+ * Same as _chunk, but for Uint8Array (or Buffer).
+ * Chunks are zero-copy views (subarray) into the input, and preserve its type
+ * (e.g Buffer in - Buffer[] out).
+ */
+export function _chunkBuffer<T extends Uint8Array>(buf: T, size: number): T[] {
+  const out: T[] = []
+
+  for (let i = 0; i < buf.length; i += size) {
+    // subarray preserves the subclass at runtime (Buffer#subarray returns a Buffer)
+    out.push(buf.subarray(i, i + size) as T)
+  }
+
+  return out
+}

package/src/buffer/index.ts

@@ -0,0 +1 @@
+export * from './buffer.util.js'