Utility functions to make dealing with Uint8Arrays easier
Uint8Array
s bring memory-efficient(ish) byte handling to browsers - they are similar to Node.js Buffer
s but lack a lot of the utility methods present on that class.
This module exports a number of function that let you do common operations - joining Uint8Arrays together, seeing if they have the same contents etc.
Since Node.js Buffer
s are also Uint8Array
s, it falls back to Buffer
internally where it makes sense for performance reasons.
Create a new Uint8Array
. When running under Node.js, Buffer
will be used in preference to Uint8Array
.
import { alloc } from 'uint8arrays/alloc'
const buf = alloc(100)
Create a new Uint8Array
. When running under Node.js, Buffer
will be used in preference to Uint8Array
.
On platforms that support it, memory referenced by the returned Uint8Array
will not be initialized.
import { allocUnsafe } from 'uint8arrays/alloc'
const buf = allocUnsafe(100)
Compare two Uint8Arrays
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]
// ]
Concatenate one or more Uint8Array
s 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.
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]
Returns true if the two arrays are the same array or if they have the same length and contents.
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
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.
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 ...
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.
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'
Returns a Uint8Array
containing a
and b
xored together.
import { xor } from 'uint8arrays/xor'
console.info(xor(Uint8Array.from([1, 0]), Uint8Array.from([0, 1]))) // Uint8Array[1, 1]
Compares the distances between two xor Uint8Array
s.
import { xor } from 'uint8arrays/xor'
import { xorCompare } from 'uint8arrays/xor-compare'
const target = Uint8Array.from([1, 1])
const val1 = Uint8Array.from([1, 0])
const xor1 = xor(target, val1)
const val2 = Uint8Array.from([0, 1])
const xor2 = xor(target, val2)
console.info(xorCompare(xor1, xor2)) // -1 or 0 or 1
$ npm i uint8arrays
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>
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)
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.