@xylabs/arraybuffer - npm Package Compare versions

Comparing version 5.0.95 to 5.0.96

package.json

 {
   "name": "@xylabs/arraybuffer",
-  "version": "5.0.95",
+  "version": "5.0.96",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
@@ -31,3 +31,2 @@ "keywords": [
       "types": "./dist/neutral/index.d.ts",
-      "import": "./dist/neutral/index.mjs",
       "default": "./dist/neutral/index.mjs"
@@ -37,3 +36,2 @@ },
   },
-  "types": "./dist/neutral/index.d.ts",
   "files": [
@@ -47,15 +45,14 @@ "dist",
   "dependencies": {
-    "@xylabs/hex": "~5.0.95",
-    "@xylabs/typeof": "~5.0.95",
-    "@xylabs/assert": "~5.0.95"
+    "@xylabs/assert": "~5.0.96",
+    "@xylabs/hex": "~5.0.96",
+    "@xylabs/typeof": "~5.0.96"
   },
   "devDependencies": {
-    "@types/node": "^25.5.2",
-    "@xylabs/ts-scripts-common": "~7.8.4",
-    "@xylabs/ts-scripts-pnpm": "~7.8.4",
-    "@xylabs/tsconfig": "~7.8.4",
+    "@types/node": "^25.6.0",
+    "@xylabs/toolchain": "~7.10.4",
+    "@xylabs/tsconfig": "~7.10.4",
     "esbuild": "^0.28.0",
     "typescript": "^5",
-    "vite": "^8.0.5",
-    "vitest": "^4.1.2",
+    "vite": "^8.0.8",
+    "vitest": "^4.1.4",
     "zod": "^4"
@@ -62,0 +59,0 @@ },

README.md

 # @xylabs/arraybuffer
 
-[![logo][]](https://xylabs.com)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
 
-[![main-build][]][main-build-link]
-[![npm-badge][]][npm-link]
-[![npm-downloads-badge][]][npm-link]
-[![jsdelivr-badge][]][jsdelivr-link]
-[![npm-license-badge][]](LICENSE)
-[![codacy-badge][]][codacy-link]
-[![codeclimate-badge][]][codeclimate-link]
-[![snyk-badge][]][snyk-link]
-[![socket-badge][]][socket-link]
+> Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
+## Install
 
-Base functionality used throughout XY Labs TypeScript/JavaScript libraries
+Using npm:
 
+```sh
+npm install {{name}}
+```
 
+Using yarn:
 
+```sh
+yarn add {{name}}
+```
+
+Using pnpm:
+
+```sh
+pnpm add {{name}}
+```
+
+Using bun:
+
+```sh
+bun add {{name}}
+```
+
+
+## License
+
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
+
 ## Reference
 
-**@xylabs/arraybuffer**
+### packages
 
-***
+  ### arraybuffer
 
-## Functions
+    ### .temp-typedoc
 
-| Function | Description |
-| ------ | ------ |
-| [equalArrayBuffers](#functions/equalArrayBuffers) | Compares two ArrayBuffers for byte-level equality. |
-| [isArrayBuffer](#functions/isArrayBuffer) | Type guard that checks if a value is an ArrayBuffer instance. |
-| [isArrayBufferLike](#functions/isArrayBufferLike) | Type guard that checks if a value conforms to the ArrayBufferLike interface (has byteLength and slice). |
-| [toArrayBuffer](#functions/toArrayBuffer) | Converts a string, bigint, or ArrayBufferLike to an ArrayBufferLike, with optional zero-padding. |
-| [toUint8Array](#functions/toUint8Array) | Converts a string, bigint, or ArrayBufferLike to a Uint8Array, with optional zero-padding. |
+      ### functions
 
-### functions
+        ### <a id="equalArrayBuffers"></a>equalArrayBuffers
 
-  ### <a id="equalArrayBuffers"></a>equalArrayBuffers
-
 [**@xylabs/arraybuffer**](#../README)
@@ -45,3 +56,3 @@
 ```ts
-function equalArrayBuffers(a1: ArrayBufferLike, a2: ArrayBufferLike): boolean;
+function equalArrayBuffers(a1, a2): boolean;
 ```
@@ -53,7 +64,14 @@
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `a1` | `ArrayBufferLike` | First buffer |
-| `a2` | `ArrayBufferLike` | Second buffer |
+### a1
 
+`ArrayBufferLike`
+
+First buffer
+
+### a2
+
+`ArrayBufferLike`
+
+Second buffer
+
 ## Returns
@@ -65,3 +83,3 @@
 
-  ### <a id="isArrayBuffer"></a>isArrayBuffer
+        ### <a id="isArrayBuffer"></a>isArrayBuffer
 
@@ -75,3 +93,3 @@ [**@xylabs/arraybuffer**](#../README)
 ```ts
-function isArrayBuffer(value: unknown): value is ArrayBuffer;
+function isArrayBuffer(value): value is ArrayBuffer;
 ```
@@ -83,6 +101,6 @@
 
-| Parameter | Type |
-| ------ | ------ |
-| `value` | `unknown` |
+### value
 
+`unknown`
+
 ### Returns
@@ -95,3 +113,3 @@
 ```ts
-function isArrayBuffer<T>(value: T): value is Extract<T, ArrayBuffer>;
+function isArrayBuffer<T>(value): value is Extract<T, ArrayBuffer>;
 ```
@@ -103,12 +121,12 @@
 
-| Type Parameter |
-| ------ |
-| `T` *extends* `ArrayBuffer` |
+### T
 
+`T` *extends* `ArrayBuffer`
+
 ### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `value` | `T` |
+### value
 
+`T`
+
 ### Returns
@@ -118,3 +136,3 @@
 
-  ### <a id="isArrayBufferLike"></a>isArrayBufferLike
+        ### <a id="isArrayBufferLike"></a>isArrayBufferLike
 
@@ -128,3 +146,3 @@ [**@xylabs/arraybuffer**](#../README)
 ```ts
-function isArrayBufferLike(value: unknown): value is ArrayBufferLike;
+function isArrayBufferLike(value): value is ArrayBufferLike;
 ```
@@ -136,6 +154,6 @@
 
-| Parameter | Type |
-| ------ | ------ |
-| `value` | `unknown` |
+### value
 
+`unknown`
+
 ### Returns
@@ -148,3 +166,3 @@
 ```ts
-function isArrayBufferLike<T>(value: T): value is Extract<T, ArrayBufferLike>;
+function isArrayBufferLike<T>(value): value is Extract<T, ArrayBufferLike>;
 ```
@@ -156,12 +174,12 @@
 
-| Type Parameter |
-| ------ |
-| `T` *extends* `ArrayBufferLike` |
+### T
 
+`T` *extends* `ArrayBufferLike`
+
 ### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `value` | `T` |
+### value
 
+`T`
+
 ### Returns
@@ -171,3 +189,3 @@
 
-  ### <a id="toArrayBuffer"></a>toArrayBuffer
+        ### <a id="toArrayBuffer"></a>toArrayBuffer
 
@@ -182,5 +200,5 @@ [**@xylabs/arraybuffer**](#../README)
 function toArrayBuffer(
-   value: undefined, 
-   padLength?: number, 
-   base?: number): undefined;
+   value, 
+   padLength?, 
+   base?): undefined;
 ```
@@ -192,8 +210,20 @@
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `undefined` | The value to convert (hex string, bigint, or existing buffer) |
-| `padLength?` | `number` | Minimum byte length, left-padded with zeros if needed |
-| `base?` | `number` | Numeric base for string parsing (default 16) |
+### value
 
+`undefined`
+
+The value to convert (hex string, bigint, or existing buffer)
+
+### padLength?
+
+`number`
+
+Minimum byte length, left-padded with zeros if needed
+
+### base?
+
+`number`
+
+Numeric base for string parsing (default 16)
+
 ### Returns
@@ -209,5 +239,5 @@
 function toArrayBuffer(
-   value: string | bigint | ArrayBufferLike, 
-   padLength?: number, 
-   base?: number): ArrayBufferLike;
+   value, 
+   padLength?, 
+   base?): ArrayBufferLike;
 ```
@@ -219,8 +249,20 @@
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `string` \| `bigint` \| `ArrayBufferLike` | The value to convert (hex string, bigint, or existing buffer) |
-| `padLength?` | `number` | Minimum byte length, left-padded with zeros if needed |
-| `base?` | `number` | Numeric base for string parsing (default 16) |
+### value
 
+`string` \| `bigint` \| `ArrayBufferLike`
+
+The value to convert (hex string, bigint, or existing buffer)
+
+### padLength?
+
+`number`
+
+Minimum byte length, left-padded with zeros if needed
+
+### base?
+
+`number`
+
+Numeric base for string parsing (default 16)
+
 ### Returns
@@ -236,5 +278,5 @@
 function toArrayBuffer(
-   value: string | bigint | ArrayBufferLike | undefined, 
-   padLength?: number, 
-   base?: number): ArrayBufferLike | undefined;
+   value, 
+   padLength?, 
+   base?): ArrayBufferLike | undefined;
 ```
@@ -246,8 +288,20 @@
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `string` \| `bigint` \| `ArrayBufferLike` \| `undefined` | The value to convert (hex string, bigint, or existing buffer) |
-| `padLength?` | `number` | Minimum byte length, left-padded with zeros if needed |
-| `base?` | `number` | Numeric base for string parsing (default 16) |
+### value
 
+`string` \| `bigint` \| `ArrayBufferLike` \| `undefined`
+
+The value to convert (hex string, bigint, or existing buffer)
+
+### padLength?
+
+`number`
+
+Minimum byte length, left-padded with zeros if needed
+
+### base?
+
+`number`
+
+Numeric base for string parsing (default 16)
+
 ### Returns
@@ -259,3 +313,3 @@
 
-  ### <a id="toUint8Array"></a>toUint8Array
+        ### <a id="toUint8Array"></a>toUint8Array
 
@@ -270,5 +324,5 @@ [**@xylabs/arraybuffer**](#../README)
 function toUint8Array(
-   value: undefined, 
-   padLength?: number, 
-   base?: number): undefined;
+   value, 
+   padLength?, 
+   base?): undefined;
 ```
@@ -280,8 +334,20 @@
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `undefined` | The value to convert |
-| `padLength?` | `number` | Minimum byte length, left-padded with zeros if needed |
-| `base?` | `number` | Numeric base for string parsing (default 16) |
+### value
 
+`undefined`
+
+The value to convert
+
+### padLength?
+
+`number`
+
+Minimum byte length, left-padded with zeros if needed
+
+### base?
+
+`number`
+
+Numeric base for string parsing (default 16)
+
 ### Returns
@@ -297,5 +363,5 @@
 function toUint8Array(
-   value: string | bigint | ArrayBufferLike, 
-   padLength?: number, 
-   base?: number): Uint8Array;
+   value, 
+   padLength?, 
+   base?): Uint8Array;
 ```
@@ -307,8 +373,20 @@
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `string` \| `bigint` \| `ArrayBufferLike` | The value to convert |
-| `padLength?` | `number` | Minimum byte length, left-padded with zeros if needed |
-| `base?` | `number` | Numeric base for string parsing (default 16) |
+### value
 
+`string` \| `bigint` \| `ArrayBufferLike`
+
+The value to convert
+
+### padLength?
+
+`number`
+
+Minimum byte length, left-padded with zeros if needed
+
+### base?
+
+`number`
+
+Numeric base for string parsing (default 16)
+
 ### Returns
@@ -324,5 +402,5 @@
 function toUint8Array(
-   value: string | bigint | ArrayBufferLike | undefined, 
-   padLength?: number, 
-   base?: number): Uint8Array<ArrayBufferLike> | undefined;
+   value, 
+   padLength?, 
+   base?): Uint8Array<ArrayBufferLike> | undefined;
 ```
@@ -334,52 +412,30 @@
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `value` | `string` \| `bigint` \| `ArrayBufferLike` \| `undefined` | The value to convert |
-| `padLength?` | `number` | Minimum byte length, left-padded with zeros if needed |
-| `base?` | `number` | Numeric base for string parsing (default 16) |
+### value
 
-### Returns
+`string` \| `bigint` \| `ArrayBufferLike` \| `undefined`
 
-`Uint8Array`\<`ArrayBufferLike`\> \| `undefined`
+The value to convert
 
-The resulting Uint8Array, or undefined if value is undefined
+### padLength?
 
+`number`
 
-Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
+Minimum byte length, left-padded with zeros if needed
 
-## Maintainers
+### base?
 
--   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
--   [Matt Jones](https://github.com/jonesmac)
--   [Joel Carter](https://github.com/JoelBCarter)
--   [Jordan Trouw](https://github.com/jordantrouw)
+`number`
 
-## License
+Numeric base for string parsing (default 16)
 
-> See the [LICENSE](LICENSE) file for license details
+### Returns
 
-## Credits
+`Uint8Array`\<`ArrayBufferLike`\> \| `undefined`
 
-[Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
+The resulting Uint8Array, or undefined if value is undefined
 
-[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
 
-[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
-[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
 [npm-badge]: https://img.shields.io/npm/v/@xylabs/arraybuffer.svg
 [npm-link]: https://www.npmjs.com/package/@xylabs/arraybuffer
-[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
-[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
-[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
-[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
-[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
-[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
-
-[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/arraybuffer
-[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/arraybuffer
-
-[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/arraybuffer/badge
-[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/arraybuffer
-
-[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/arraybuffer
-[socket-link]: https://socket.dev/npm/package/@xylabs/arraybuffer
+[license-badge]: https://img.shields.io/npm/l/@xylabs/arraybuffer.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

No alert changes

Improved metrics

Dev dependency count

8

-11.11%

Number of lines in readme file

416

15.88%

Worsened metrics

Total package byte prevSize

29255

-10.63%

Dependency changes

• Updated

  @xylabs/assert@~5.0.96

• Updated

  @xylabs/hex@~5.0.96

• Updated

  @xylabs/typeof@~5.0.96