uint8arrays

What is uint8arrays?

The uint8arrays npm package provides utilities for working with Uint8Array objects in JavaScript. It includes functions for concatenation, comparison, conversion to and from strings, and more.

What are uint8arrays's main functionalities?

Concatenation

This feature allows you to concatenate multiple Uint8Array objects into a single Uint8Array.

const uint8arrays = require('uint8arrays');
const arr1 = new Uint8Array([1, 2, 3]);
const arr2 = new Uint8Array([4, 5, 6]);
const concatenated = uint8arrays.concat([arr1, arr2]);
console.log(concatenated); // Uint8Array [1, 2, 3, 4, 5, 6]

Comparison

This feature allows you to compare two Uint8Array objects for equality.

const uint8arrays = require('uint8arrays');
const arr1 = new Uint8Array([1, 2, 3]);
const arr2 = new Uint8Array([1, 2, 3]);
const arr3 = new Uint8Array([4, 5, 6]);
console.log(uint8arrays.equals(arr1, arr2)); // true
console.log(uint8arrays.equals(arr1, arr3)); // false

Conversion to and from Strings

This feature allows you to convert Uint8Array objects to and from strings using various encodings.

const uint8arrays = require('uint8arrays');
const arr = new Uint8Array([72, 101, 108, 108, 111]);
const str = uint8arrays.toString(arr, 'utf8');
console.log(str); // 'Hello'
const newArr = uint8arrays.fromString('Hello', 'utf8');
console.log(newArr); // Uint8Array [72, 101, 108, 108, 111]

Other packages similar to uint8arrays

buffer

The buffer package provides a way of handling binary data in Node.js. It includes many similar functionalities to uint8arrays, such as concatenation, comparison, and conversion to and from strings. However, buffer is more tightly integrated with Node.js and provides additional features like reading and writing to files.

typedarray

The typedarray package provides polyfills for JavaScript's typed array functionality, including Uint8Array. While it doesn't offer as many utility functions as uint8arrays, it ensures compatibility with older JavaScript environments that do not support typed arrays natively.

README

uint8arrays

Utility functions to make dealing with Uint8Arrays easier

Table of contents

• Install
  • Browser <script> tag
• API
  • alloc(size)
    • Example
  • allocUnsafe(size)
    • Example
  • compare(a, b)
    • Example
  • concat(arrays, [length])
    • Example
  • equals(a, b)
    • Example
  • fromString(string, encoding = 'utf8')
    • Example
  • toString(array, encoding = 'utf8')
    • Example
  • xor(a, b)
    • Example
• License
• Contribution

Install

$ npm i uint8arrays

Browser <script> tag

Loading this module through a script tag will make it's exports available as Uint8arrays in the global namespace.

<script src="https://unpkg.com/uint8arrays/dist/index.min.js"></script>

API

alloc(size)

Create a new Uint8Array. If globalThis.Buffer is defined, it will be used in preference to globalThis.Uint8Array.

Example

import { alloc } from 'uint8arrays/alloc`

const buf = alloc(100)

allocUnsafe(size)

Create a new Uint8Array. If globalThis.Buffer is defined, it will be used in preference to globalThis.Uint8Array.

On platforms that support it, memory referenced by the returned Uint8Array will not be initialized.

Example

import { allocUnsafe } from 'uint8arrays/alloc`

const buf = allocUnsafe(100)

compare(a, b)

Compare two Uint8Arrays

Example

import { compare } from 'uint8arrays/compare'

const arrays = [
  Uint8Array.from([3, 4, 5]),
  Uint8Array.from([0, 1, 2])
]

const sorted = arrays.sort(compare)

console.info(sorted)
// [
//    Uint8Array[0, 1, 2]
//    Uint8Array[3, 4, 5]
// ]

concat(arrays, [length])

Concatenate one or more array-likes and return a Uint8Array with their contents.

If you know the length of the arrays, pass it as a second parameter, otherwise it will be calculated by traversing the list of arrays.

Example

import { concat } from 'uint8arrays/concat'

const arrays = [
  Uint8Array.from([0, 1, 2]),
  Uint8Array.from([3, 4, 5])
]

const all = concat(arrays, 6)

console.info(all)
// Uint8Array[0, 1, 2, 3, 4, 5]

equals(a, b)

Returns true if the two arrays are the same array or if they have the same length and contents.

Example

import { equals } from 'uint8arrays/equals'

const a = Uint8Array.from([0, 1, 2])
const b = Uint8Array.from([3, 4, 5])
const c = Uint8Array.from([0, 1, 2])

console.info(equals(a, b)) // false
console.info(equals(a, c)) // true
console.info(equals(a, a)) // true

fromString(string, encoding = 'utf8')

Returns a new Uint8Array created from the passed string and interpreted as the passed encoding.

Supports utf8 and any of the multibase encodings as implemented by the multiformats module.

Example

import { fromString } from 'uint8arrays/from-string'

console.info(fromString('hello world')) // Uint8Array[104, 101 ...
console.info(fromString('00010203aabbcc', 'base16')) // Uint8Array[0, 1 ...
console.info(fromString('AAECA6q7zA', 'base64')) // Uint8Array[0, 1 ...
console.info(fromString('01234', 'ascii')) // Uint8Array[48, 49 ...

toString(array, encoding = 'utf8')

Returns a string created from the passed Uint8Array in the passed encoding.

Supports utf8 and any of the multibase encodings as implemented by the multiformats module.

Example

import { toString } from 'uint8arrays/to-string'

console.info(toString(Uint8Array.from([104, 101...]))) // 'hello world'
console.info(toString(Uint8Array.from([0, 1, 2...]), 'base16')) // '00010203aabbcc'
console.info(toString(Uint8Array.from([0, 1, 2...]), 'base64')) // 'AAECA6q7zA'
console.info(toString(Uint8Array.from([48, 49, 50...]), 'ascii')) // '01234'

xor(a, b)

Returns a Uint8Array containing a and b xored together.

Example

import { xor } from 'uint8arrays/xor'

console.info(xor(Uint8Array.from([1, 0]), Uint8Array.from([0, 1]))) // Uint8Array[1, 1]

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.