@xylabs/arraybuffer

Base functionality used throughout XY Labs TypeScript/JavaScript libraries

Reference

@xylabs/arraybuffer

Functions

| Function | Description | | ------ | ------ | | equalArrayBuffers | Compares two ArrayBuffers for byte-level equality. | | isArrayBuffer | Type guard that checks if a value is an ArrayBuffer instance. | | isArrayBufferLike | Type guard that checks if a value conforms to the ArrayBufferLike interface (has byteLength and slice). | | toArrayBuffer | Converts a string, bigint, or ArrayBufferLike to an ArrayBufferLike, with optional zero-padding. | | toUint8Array | Converts a string, bigint, or ArrayBufferLike to a Uint8Array, with optional zero-padding. |

functions

equalArrayBuffers

@xylabs/arraybuffer

function equalArrayBuffers(a1: ArrayBufferLike, a2: ArrayBufferLike): boolean;

Compares two ArrayBuffers for byte-level equality.

Parameters

| Parameter | Type | Description | | ------ | ------ | ------ | | a1 | ArrayBufferLike | First buffer | | a2 | ArrayBufferLike | Second buffer |

Returns

boolean

True if the buffers have the same length and identical bytes

isArrayBuffer

@xylabs/arraybuffer

Call Signature

function isArrayBuffer(value: unknown): value is ArrayBuffer;

Type guard that checks if a value is an ArrayBuffer instance.

Parameters

| Parameter | Type | | ------ | ------ | | value | unknown |

Returns

value is ArrayBuffer

Call Signature

function isArrayBuffer<T>(value: T): value is Extract<T, ArrayBuffer>;

Type guard that checks if a value is an ArrayBuffer instance.

Type Parameters

| Type Parameter | | ------ | | T extends ArrayBuffer |

Parameters

| Parameter | Type | | ------ | ------ | | value | T |

Returns

value is Extract<T, ArrayBuffer>

isArrayBufferLike

@xylabs/arraybuffer

Call Signature

function isArrayBufferLike(value: unknown): value is ArrayBufferLike;

Type guard that checks if a value conforms to the ArrayBufferLike interface (has byteLength and slice).

Parameters

| Parameter | Type | | ------ | ------ | | value | unknown |

Returns

value is ArrayBufferLike

Call Signature

function isArrayBufferLike<T>(value: T): value is Extract<T, ArrayBufferLike>;

Type guard that checks if a value conforms to the ArrayBufferLike interface (has byteLength and slice).

Type Parameters

| Type Parameter | | ------ | | T extends ArrayBufferLike |

Parameters

| Parameter | Type | | ------ | ------ | | value | T |

Returns

value is Extract<T, ArrayBufferLike>

toArrayBuffer

@xylabs/arraybuffer

Call Signature

function toArrayBuffer(
   value: undefined, 
   padLength?: number, 
   base?: number): undefined;

Converts a string, bigint, or ArrayBufferLike to an ArrayBufferLike, with optional zero-padding.

Parameters

| 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) |

Returns

undefined

The resulting ArrayBufferLike, or undefined if value is undefined

Call Signature

function toArrayBuffer(
   value: string | bigint | ArrayBufferLike, 
   padLength?: number, 
   base?: number): ArrayBufferLike;

Converts a string, bigint, or ArrayBufferLike to an ArrayBufferLike, with optional zero-padding.

Parameters

| 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) |

Returns

ArrayBufferLike

The resulting ArrayBufferLike, or undefined if value is undefined

Call Signature

function toArrayBuffer(
   value: string | bigint | ArrayBufferLike | undefined, 
   padLength?: number, 
   base?: number): ArrayBufferLike | undefined;

Converts a string, bigint, or ArrayBufferLike to an ArrayBufferLike, with optional zero-padding.

Parameters

| 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) |

Returns

ArrayBufferLike | undefined

The resulting ArrayBufferLike, or undefined if value is undefined

toUint8Array

@xylabs/arraybuffer

Call Signature

function toUint8Array(
   value: undefined, 
   padLength?: number, 
   base?: number): undefined;

Converts a string, bigint, or ArrayBufferLike to a Uint8Array, with optional zero-padding.

Parameters

| 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) |

Returns

undefined

The resulting Uint8Array, or undefined if value is undefined

Call Signature

function toUint8Array(
   value: string | bigint | ArrayBufferLike, 
   padLength?: number, 
   base?: number): Uint8Array;

Converts a string, bigint, or ArrayBufferLike to a Uint8Array, with optional zero-padding.

Parameters

| 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) |

Returns

Uint8Array

The resulting Uint8Array, or undefined if value is undefined

Call Signature

function toUint8Array(
   value: string | bigint | ArrayBufferLike | undefined, 
   padLength?: number, 
   base?: number): Uint8Array<ArrayBufferLike> | undefined;

Converts a string, bigint, or ArrayBufferLike to a Uint8Array, with optional zero-padding.

Parameters

| 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) |

Returns

Uint8Array<ArrayBufferLike> | undefined

The resulting Uint8Array, or undefined if value is undefined

Part of sdk-js

Maintainers

• Arie Trouw (arietrouw.com)
• Matt Jones
• Joel Carter
• Jordan Trouw

License

See the LICENSE file for license details

Credits

Made with 🔥 and ❄️ by XYLabs