Socket
Socket
Sign inDemoInstall

uint8arrays

Package Overview
Dependencies
1
Maintainers
1
Versions
43
Alerts
File Explorer

Advanced tools

npm Scripts
License

Install Socket

Detect and block malicious and high-risk dependencies

Install

Comparing version 4.0.7 to 4.0.8

dist/typedoc-urls.json

144

dist/src/index.d.ts

@@ -0,1 +1,145 @@

/**
* @packageDocumentation
*
* `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.
*
* ## alloc(size)
*
* Create a new `Uint8Array`. If `globalThis.Buffer` is defined, it will be used in preference to `globalThis.Uint8Array`.
*
* ### Example
*
* ```js
* 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
*
* ```js
* import { allocUnsafe } from 'uint8arrays/alloc'
*
* const buf = allocUnsafe(100)
* ```
*
* ## compare(a, b)
*
* Compare two `Uint8Arrays`
*
* ### Example
*
* ```js
* 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
*
* ```js
* 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
*
* ```js
* 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](https://github.com/multiformats/multibase/blob/master/multibase.csv) as implemented by the [multiformats module](https://www.npmjs.com/package/multiformats).
*
* ### Example
*
* ```js
* 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](https://github.com/multiformats/multibase/blob/master/multibase.csv) as implemented by the [multiformats module](https://www.npmjs.com/package/multiformats).
*
* ### Example
*
* ```js
* 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
*
* ```js
* import { xor } from 'uint8arrays/xor'
*
* console.info(xor(Uint8Array.from([1, 0]), Uint8Array.from([0, 1]))) // Uint8Array[1, 1]
* ```
*/
import { compare } from './compare.js';

@@ -2,0 +146,0 @@ import { concat } from './concat.js';

144

dist/src/index.js

@@ -0,1 +1,145 @@

/**
* @packageDocumentation
*
* `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.
*
* ## alloc(size)
*
* Create a new `Uint8Array`. If `globalThis.Buffer` is defined, it will be used in preference to `globalThis.Uint8Array`.
*
* ### Example
*
* ```js
* 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
*
* ```js
* import { allocUnsafe } from 'uint8arrays/alloc'
*
* const buf = allocUnsafe(100)
* ```
*
* ## compare(a, b)
*
* Compare two `Uint8Arrays`
*
* ### Example
*
* ```js
* 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
*
* ```js
* 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
*
* ```js
* 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](https://github.com/multiformats/multibase/blob/master/multibase.csv) as implemented by the [multiformats module](https://www.npmjs.com/package/multiformats).
*
* ### Example
*
* ```js
* 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](https://github.com/multiformats/multibase/blob/master/multibase.csv) as implemented by the [multiformats module](https://www.npmjs.com/package/multiformats).
*
* ### Example
*
* ```js
* 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
*
* ```js
* import { xor } from 'uint8arrays/xor'
*
* console.info(xor(Uint8Array.from([1, 0]), Uint8Array.from([0, 1]))) // Uint8Array[1, 1]
* ```
*/
import { compare } from './compare.js';

@@ -2,0 +146,0 @@ import { concat } from './concat.js';

8

package.json
{
"name": "uint8arrays",
"version": "4.0.7",
"version": "4.0.8",
"description": "Utility functions to make dealing with Uint8Arrays easier",

@@ -76,2 +76,3 @@ "author": "Alex Potsides <alex@achingbrain.net>",

"parserOptions": {
"project": true,
"sourceType": "module"

@@ -176,3 +177,4 @@ }

"build": "aegir build",
"dep-check": "aegir dep-check"
"dep-check": "aegir dep-check",
"docs": "aegir docs"
},

@@ -184,5 +186,5 @@ "dependencies": {

"@types/benchmark": "^2.1.1",
"aegir": "^40.0.8",
"aegir": "^41.1.9",
"benchmark": "^2.1.4"
}
}

171

README.md

@@ -1,3 +0,1 @@

# uint8arrays <!-- omit in toc -->
[![codecov](https://img.shields.io/codecov/c/github/achingbrain/uint8arrays.svg?style=flat-square)](https://codecov.io/gh/achingbrain/uint8arrays)

@@ -8,28 +6,4 @@ [![CI](https://img.shields.io/github/actions/workflow/status/achingbrain/uint8arrays/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/achingbrain/uint8arrays/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)

## Table of contents <!-- omit in toc -->
# Install
- [Install](#install)
- [Browser `<script>` tag](#browser-script-tag)
- [API](#api)
- [alloc(size)](#allocsize)
- [Example](#example)
- [allocUnsafe(size)](#allocunsafesize)
- [Example](#example-1)
- [compare(a, b)](#comparea-b)
- [Example](#example-2)
- [concat(arrays, \[length\])](#concatarrays-length)
- [Example](#example-3)
- [equals(a, b)](#equalsa-b)
- [Example](#example-4)
- [fromString(string, encoding = 'utf8')](#fromstringstring-encoding--utf8)
- [Example](#example-5)
- [toString(array, encoding = 'utf8')](#tostringarray-encoding--utf8)
- [Example](#example-6)
- [xor(a, b)](#xora-b)
- [Example](#example-7)
- [License](#license)
- [Contribution](#contribution)
## Install
```console

@@ -39,3 +13,3 @@ $ npm i uint8arrays

### Browser `<script>` tag
## Browser `<script>` tag

@@ -48,141 +22,8 @@ Loading this module through a script tag will make it's exports available as `Uint8arrays` in the global namespace.

## API
# API Docs
### alloc(size)
- <https://achingbrain.github.io/uint8arrays>
Create a new `Uint8Array`. If `globalThis.Buffer` is defined, it will be used in preference to `globalThis.Uint8Array`.
# License
#### Example
```js
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
```js
import { allocUnsafe } from 'uint8arrays/alloc'
const buf = allocUnsafe(100)
```
### compare(a, b)
Compare two `Uint8Arrays`
#### Example
```js
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
```js
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
```js
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](https://github.com/multiformats/multibase/blob/master/multibase.csv) as implemented by the [multiformats module](https://www.npmjs.com/package/multiformats).
#### Example
```js
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](https://github.com/multiformats/multibase/blob/master/multibase.csv) as implemented by the [multiformats module](https://www.npmjs.com/package/multiformats).
#### Example
```js
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
```js
import { xor } from 'uint8arrays/xor'
console.info(xor(Uint8Array.from([1, 0]), Uint8Array.from([0, 1]))) // Uint8Array[1, 1]
```
## License
Licensed under either of

@@ -193,4 +34,4 @@

## Contribution
# 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.

145

src/index.ts

@@ -0,1 +1,146 @@

/**
* @packageDocumentation
*
* `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.
*
* ## alloc(size)
*
* Create a new `Uint8Array`. If `globalThis.Buffer` is defined, it will be used in preference to `globalThis.Uint8Array`.
*
* ### Example
*
* ```js
* 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
*
* ```js
* import { allocUnsafe } from 'uint8arrays/alloc'
*
* const buf = allocUnsafe(100)
* ```
*
* ## compare(a, b)
*
* Compare two `Uint8Arrays`
*
* ### Example
*
* ```js
* 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
*
* ```js
* 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
*
* ```js
* 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](https://github.com/multiformats/multibase/blob/master/multibase.csv) as implemented by the [multiformats module](https://www.npmjs.com/package/multiformats).
*
* ### Example
*
* ```js
* 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](https://github.com/multiformats/multibase/blob/master/multibase.csv) as implemented by the [multiformats module](https://www.npmjs.com/package/multiformats).
*
* ### Example
*
* ```js
* 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
*
* ```js
* import { xor } from 'uint8arrays/xor'
*
* console.info(xor(Uint8Array.from([1, 0]), Uint8Array.from([0, 1]))) // Uint8Array[1, 1]
* ```
*/
import { compare } from './compare.js'

@@ -2,0 +147,0 @@ import { concat } from './concat.js'

dist/src/index.d.ts.map

Sorry, the diff of this file is not supported yet

dist/src/index.js.map

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc