@exodus/bytes 1.9.0 → 1.10.0

package/README.md

@@ -4,6 +4,7 @@
 [![](https://flat.badgen.net/github/release/ExodusOSS/bytes?icon=github)](https://github.com/ExodusOSS/bytes/releases)
 [![](https://flat.badgen.net/npm/dm/@exodus/bytes)](https://www.npmcharts.com/compare/@exodus/bytes?minimal=true)
 [![](https://flat.badgen.net/npm/license/@exodus/bytes)](https://github.com/ExodusOSS/bytes/blob/HEAD/LICENSE)
+[![](https://flat.badgen.net/github/checks/ExodusOSS/bytes/main?icon=github)](https://github.com/ExodusOSS/bytes/actions/workflows/test.yml?query=branch%3Amain)
 
 `Uint8Array` conversion to and from `base64`, `base32`, `base58`, `hex`, `utf8`, `utf16`, `bech32` and `wif`
 
@@ -99,6 +100,8 @@ See [the list of encodings](https://encoding.spec.whatwg.org/#names-and-labels).
 
 ### `@exodus/bytes/utf8.js`
 
+UTF-8 encoding/decoding
+
 ```js
 import { utf8fromString, utf8toString } from '@exodus/bytes/utf8.js'
 
@@ -106,13 +109,45 @@ import { utf8fromString, utf8toString } from '@exodus/bytes/utf8.js'
 import { utf8fromStringLoose, utf8toStringLoose } from '@exodus/bytes/utf8.js'
 ```
 
-##### `utf8fromString(str, format = 'uint8')`
-##### `utf8fromStringLoose(str, format = 'uint8')`
-##### `utf8toString(arr)`
-##### `utf8toStringLoose(arr)`
+_These methods by design encode/decode BOM (codepoint `U+FEFF` Byte Order Mark) as-is._\
+_If you need BOM handling or detection, use `@exodus/bytes/encoding.js`_
+
+#### `utf8fromString(string, format = 'uint8')`
+
+Encode a string to UTF-8 bytes (strict mode)
+
+Throws on invalid Unicode (unpaired surrogates)
+
+#### `utf8fromStringLoose(string, format = 'uint8')`
+
+Encode a string to UTF-8 bytes (loose mode)
+
+Replaces invalid Unicode (unpaired surrogates) with replacement codepoints `U+FFFD`
+per [WHATWG Encoding](https://encoding.spec.whatwg.org/) specification.
+
+_Such replacement is a non-injective function, is irreversable and causes collisions.\
+Prefer using strict throwing methods for cryptography applications._
+
+#### `utf8toString(arr)`
+
+Decode UTF-8 bytes to a string (strict mode)
+
+Throws on invalid UTF-8 byte sequences
+
+#### `utf8toStringLoose(arr)`
+
+Decode UTF-8 bytes to a string (loose mode)
+
+Replaces invalid UTF-8 byte sequences with replacement codepoints `U+FFFD`
+per [WHATWG Encoding](https://encoding.spec.whatwg.org/) specification.
+
+_Such replacement is a non-injective function, is irreversable and causes collisions.\
+Prefer using strict throwing methods for cryptography applications._
 
 ### `@exodus/bytes/utf16.js`
 
+UTF-16 encoding/decoding
+
 ```js
 import { utf16fromString, utf16toString } from '@exodus/bytes/utf16.js'
 
@@ -120,18 +155,46 @@ import { utf16fromString, utf16toString } from '@exodus/bytes/utf16.js'
 import { utf16fromStringLoose, utf16toStringLoose } from '@exodus/bytes/utf16.js'
 ```
 
-##### `utf16fromString(str, format = 'uint16')`
-##### `utf16fromStringLoose(str, format = 'uint16')`
-##### `utf16toString(arr, 'uint16')`
-##### `utf16toStringLoose(arr, 'uint16')`
+_These methods by design encode/decode BOM (codepoint `U+FEFF` Byte Order Mark) as-is._\
+_If you need BOM handling or detection, use `@exodus/bytes/encoding.js`_
 
-### `@exodus/bytes/single-byte.js`
+#### `utf16fromString(string, format = 'uint16')`
 
-```js
-import { createSinglebyteDecoder, createSinglebyteEncoder } from '@exodus/bytes/single-byte.js'
-import { windows1252toString, windows1252fromString } from '@exodus/bytes/single-byte.js'
-import { latin1toString, latin1fromString } from '@exodus/bytes/single-byte.js'
-```
+Encode a string to UTF-16 bytes (strict mode)
+
+Throws on invalid Unicode (unpaired surrogates)
+
+#### `utf16fromStringLoose(string, format = 'uint16')`
+
+Encode a string to UTF-16 bytes (loose mode)
+
+Replaces invalid Unicode (unpaired surrogates) with replacement codepoints `U+FFFD`
+per [WHATWG Encoding](https://encoding.spec.whatwg.org/) specification.
+
+_Such replacement is a non-injective function, is irreversible and causes collisions.\
+Prefer using strict throwing methods for cryptography applications._
+
+#### `utf16toString(arr, format = 'uint16')`
+
+Decode UTF-16 bytes to a string (strict mode)
+
+Throws on invalid UTF-16 byte sequences
+
+Throws on non-even byte length.
+
+#### `utf16toStringLoose(arr, format = 'uint16')`
+
+Decode UTF-16 bytes to a string (loose mode)
+
+Replaces invalid UTF-16 byte sequences with replacement codepoints `U+FFFD`
+per [WHATWG Encoding](https://encoding.spec.whatwg.org/) specification.
+
+_Such replacement is a non-injective function, is irreversible and causes collisions.\
+Prefer using strict throwing methods for cryptography applications._
+
+Throws on non-even byte length.
+
+### `@exodus/bytes/single-byte.js`
 
 Decode / encode the legacy single-byte encodings according to the
 [Encoding standard](https://encoding.spec.whatwg.org/)
@@ -139,6 +202,12 @@ Decode / encode the legacy single-byte encodings according to the
 [§14.5](https://encoding.spec.whatwg.org/#x-user-defined)),
 and [unicode.org](https://unicode.org/Public/MAPPINGS/ISO8859) `iso-8859-*` mappings.
 
+```js
+import { createSinglebyteDecoder, createSinglebyteEncoder } from '@exodus/bytes/single-byte.js'
+import { windows1252toString, windows1252fromString } from '@exodus/bytes/single-byte.js'
+import { latin1toString, latin1fromString } from '@exodus/bytes/single-byte.js'
+```
+
 Supports all single-byte encodings listed in the WHATWG Encoding standard:
 `ibm866`, `iso-8859-2`, `iso-8859-3`, `iso-8859-4`, `iso-8859-5`, `iso-8859-6`, `iso-8859-7`, `iso-8859-8`,
 `iso-8859-8-i`, `iso-8859-10`, `iso-8859-13`, `iso-8859-14`, `iso-8859-15`, `iso-8859-16`, `koi8-r`, `koi8-u`,
@@ -174,13 +243,13 @@ corresponding [unicode.org encodings](https://unicode.org/Public/MAPPINGS/VENDOR
 they encode/decode all the old valid (non-replacement) strings / byte sequences identically, but can also support
 a wider range of inputs.
 
-##### `createSinglebyteDecoder(encoding, loose = false)`
+#### `createSinglebyteDecoder(encoding, loose = false)`
 
 Create a decoder for a supported one-byte `encoding`, given its lowercased name `encoding`.
 
 Returns a function `decode(arr)` that decodes bytes to a string.
 
-##### `createSinglebyteEncoder(encoding, { mode = 'fatal' })`
+#### `createSinglebyteEncoder(encoding, { mode = 'fatal' })`
 
 Create an encoder for a supported one-byte `encoding`, given its lowercased name `encoding`.
 
@@ -189,7 +258,7 @@ Returns a function `encode(string)` that encodes a string to bytes.
 In `'fatal'` mode (default), will throw on non well-formed strings or any codepoints which could
 not be encoded in the target encoding.
 
-##### `latin1toString(arr)`
+#### `latin1toString(arr)`
 
 Decode `iso-8859-1` bytes to a string.
 
@@ -203,18 +272,18 @@ const latin1toString = createSinglebyteDecoder('iso-8859-1')
 Note: this is different from `new TextDecoder('iso-8859-1')` and `new TextDecoder('latin1')`, as
 those alias to `new TextDecoder('windows-1252')`.
 
-##### `latin1fromString(string)`
+#### `latin1fromString(string)`
 
 Encode a string to `iso-8859-1` bytes.
 
-Will throw on non well-formed strings or any codepoints which could not be encoded in `iso-8859-1`.
+Throws on non well-formed strings or any codepoints which could not be encoded in `iso-8859-1`.
 
 Same as:
 ```js
 const latin1fromString = createSinglebyteEncoder('iso-8859-1', { mode: 'fatal' })
 ```
 
-##### `windows1252toString(arr)`
+#### `windows1252toString(arr)`
 
 Decode `windows-1252` bytes to a string.
 
@@ -225,11 +294,11 @@ Same as:
 const windows1252toString = createSinglebyteDecoder('windows-1252')
 ```
 
-##### `windows1252fromString(string)`
+#### `windows1252fromString(string)`
 
 Encode a string to `windows-1252` bytes.
 
-Will throw on non well-formed strings or any codepoints which could not be encoded in `windows-1252`.
+Throws on non well-formed strings or any codepoints which could not be encoded in `windows-1252`.
 
 Same as:
 ```js
@@ -238,50 +307,84 @@ const windows1252fromString = createSinglebyteEncoder('windows-1252', { mode: 'f
 
 ### `@exodus/bytes/multi-byte.js`
 
-```js
-import { createMultibyteDecoder } from '@exodus/bytes/multi-byte.js'
-```
-
-Decode the legacy multi-byte encodings according to the [Encoding standard](https://encoding.spec.whatwg.org/)
+Decode / encode the legacy multi-byte encodings according to the
+[Encoding standard](https://encoding.spec.whatwg.org/)
 ([§10](https://encoding.spec.whatwg.org/#legacy-multi-byte-chinese-(simplified)-encodings),
 [§11](https://encoding.spec.whatwg.org/#legacy-multi-byte-chinese-(traditional)-encodings),
 [§12](https://encoding.spec.whatwg.org/#legacy-multi-byte-japanese-encodings),
 [§13](https://encoding.spec.whatwg.org/#legacy-multi-byte-korean-encodings)).
 
-Supports all legacy multi-byte encodings listed in the standard:
+```js
+import { createMultibyteDecoder, createMultibyteEncoder } from '@exodus/bytes/multi-byte.js'
+```
+
+Supports all legacy multi-byte encodings listed in the WHATWG Encoding standard:
 `gbk`, `gb18030`, `big5`, `euc-jp`, `iso-2022-jp`, `shift_jis`, `euc-kr`.
 
-##### `createMultibyteDecoder(encoding, loose = false)`
+#### `createMultibyteDecoder(encoding, loose = false)`
 
 Create a decoder for a supported legacy multi-byte `encoding`, given its lowercased name `encoding`.
 
 Returns a function `decode(arr, stream = false)` that decodes bytes to a string.
 
-That function will have state while `stream = true` is used.
+The returned function will maintain internal state while `stream = true` is used, allowing it to
+handle incomplete multi-byte sequences across multiple calls.
+State is reset when `stream = false` or when the function is called without the `stream` parameter.
+
+#### `createMultibyteEncoder(encoding, { mode = 'fatal' })`
+
+Create an encoder for a supported legacy multi-byte `encoding`, given its lowercased name `encoding`.
+
+Returns a function `encode(string)` that encodes a string to bytes.
+
+In `'fatal'` mode (default), will throw on non well-formed strings or any codepoints which could
+not be encoded in the target encoding.
 
 ### `@exodus/bytes/bigint.js`
 
+Convert between BigInt and Uint8Array
+
 ```js
 import { fromBigInt, toBigInt } from '@exodus/bytes/bigint.js'
 ```
 
-##### `fromBigInt(bigint, { length, format = 'uint8' })`
-##### `toBigInt(arr)`
+#### `fromBigInt(bigint, { length, format = 'uint8' })`
+
+Convert a BigInt to a Uint8Array or Buffer
+
+The output bytes are in big-endian format.
+
+Throws if the BigInt is negative or cannot fit into the specified length.
+
+#### `toBigInt(arr)`
+
+Convert a Uint8Array or Buffer to a BigInt
+
+The bytes are interpreted as a big-endian unsigned integer.
 
 ### `@exodus/bytes/hex.js`
 
-Implements Base16 from [RFC4648](https://datatracker.ietf.org/doc/html/rfc4648) (no differences from [RFC3548](https://datatracker.ietf.org/doc/html/rfc4648)).
+Implements Base16 from [RFC4648](https://datatracker.ietf.org/doc/html/rfc4648)
+(no differences from [RFC3548](https://datatracker.ietf.org/doc/html/rfc4648)).
 
 ```js
 import { fromHex, toHex } from '@exodus/bytes/hex.js'
 ```
 
-##### `fromHex(string)`
-##### `toHex(arr)`
+#### `fromHex(string, format = 'uint8')`
+
+Decode a hex string to bytes
+
+Unlike `Buffer.from()`, throws on invalid input
+
+#### `toHex(arr)`
+
+Encode a `Uint8Array` to a lowercase hex string
 
 ### `@exodus/bytes/base64.js`
 
-Implements Base64 from [RFC4648](https://datatracker.ietf.org/doc/html/rfc4648) (no differences from [RFC3548](https://datatracker.ietf.org/doc/html/rfc4648)).
+Implements base64 and base64url from [RFC4648](https://datatracker.ietf.org/doc/html/rfc4648)
+(no differences from [RFC3548](https://datatracker.ietf.org/doc/html/rfc4648)).
 
 ```js
 import { fromBase64, toBase64 } from '@exodus/bytes/base64.js'
@@ -289,29 +392,67 @@ import { fromBase64url, toBase64url } from '@exodus/bytes/base64.js'
 import { fromBase64any } from '@exodus/bytes/base64.js'
 ```
 
-##### `fromBase64(str, { format = 'uint8', padding = 'both' })`
-##### `fromBase64url(str, { format = 'uint8', padding = false })`
-##### `fromBase64any(str, { format = 'uint8', padding = 'both' })`
-##### `toBase64(arr, { padding = true })`
-##### `toBase64url(arr, { padding = false })`
+#### `fromBase64(string, { format = 'uint8', padding = 'both' })`
+
+Decode a base64 string to bytes
+
+Operates in strict mode for last chunk, does not allow whitespace
+
+#### `fromBase64url(string, { format = 'uint8', padding = false })`
+
+Decode a base64url string to bytes
+
+Operates in strict mode for last chunk, does not allow whitespace
+
+#### `fromBase64any(string, { format = 'uint8', padding = 'both' })`
+
+Decode either base64 or base64url string to bytes
+
+Automatically detects the variant based on characters present
+
+#### `toBase64(arr, { padding = true })`
+
+Encode a `Uint8Array` to a base64 string (RFC 4648)
+
+#### `toBase64url(arr, { padding = false })`
+
+Encode a `Uint8Array` to a base64url string (RFC 4648)
 
 ### `@exodus/bytes/base32.js`
 
-Implements Base32 from [RFC4648](https://datatracker.ietf.org/doc/html/rfc4648) (no differences from [RFC3548](https://datatracker.ietf.org/doc/html/rfc4648)).
+Implements base32 and base32hex from [RFC4648](https://datatracker.ietf.org/doc/html/rfc4648)
+(no differences from [RFC3548](https://datatracker.ietf.org/doc/html/rfc4648)).
 
 ```js
 import { fromBase32, toBase32 } from '@exodus/bytes/base32.js'
 import { fromBase32hex, toBase32hex } from '@exodus/bytes/base32.js'
 ```
 
-##### `fromBase32(str, { format = 'uint8', padding = 'both' })`
-##### `fromBase32hex(str, { format = 'uint8', padding = 'both' })`
-##### `toBase32(arr, { padding = false })`
-##### `toBase32hex(arr, { padding = false })`
+#### `fromBase32(string, { format = 'uint8', padding = 'both' })`
+
+Decode a base32 string to bytes
+
+Operates in strict mode for last chunk, does not allow whitespace
+
+#### `fromBase32hex(string, { format = 'uint8', padding = 'both' })`
+
+Decode a base32hex string to bytes
+
+Operates in strict mode for last chunk, does not allow whitespace
+
+#### `toBase32(arr, { padding = false })`
+
+Encode a `Uint8Array` to a base32 string (RFC 4648)
+
+#### `toBase32hex(arr, { padding = false })`
+
+Encode a `Uint8Array` to a base32hex string (RFC 4648)
 
 ### `@exodus/bytes/bech32.js`
 
-Implements [BIP-0173](https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki#specification) and [BIP-0350](https://github.com/bitcoin/bips/blob/master/bip-0350.mediawiki#specification).
+Implements bech32 and bech32m from
+[BIP-0173](https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki#specification)
+and [BIP-0350](https://github.com/bitcoin/bips/blob/master/bip-0350.mediawiki#specification).
 
 ```js
 import { fromBech32, toBech32 } from '@exodus/bytes/bech32.js'
@@ -319,29 +460,67 @@ import { fromBech32m, toBech32m } from '@exodus/bytes/bech32.js'
 import { getPrefix } from '@exodus/bytes/bech32.js'
 ```
 
-##### `getPrefix(str, limit = 90)`
+#### `getPrefix(string, limit = 90)`
+
+Extract the prefix from a bech32 or bech32m string without full validation
+
+This is a quick check that skips most validation.
+
+#### `fromBech32(string, limit = 90)`
+
+Decode a bech32 string to bytes
+
+#### `toBech32(prefix, bytes, limit = 90)`
 
-##### `fromBech32(str, limit = 90)`
-##### `toBech32(prefix, bytes, limit = 90)`
+Encode bytes to a bech32 string
 
-##### `fromBech32m(str, limit = 90)`
-##### `toBech32m(prefix, bytes, limit = 90)`
+#### `fromBech32m(string, limit = 90)`
+
+Decode a bech32m string to bytes
+
+#### `toBech32m(prefix, bytes, limit = 90)`
+
+Encode bytes to a bech32m string
 
 ### `@exodus/bytes/base58.js`
 
+Implements [base58](https://www.ietf.org/archive/id/draft-msporny-base58-03.txt) encoding.
+
+Supports both standard base58 and XRP variant alphabets.
+
 ```js
 import { fromBase58, toBase58 } from '@exodus/bytes/base58.js'
 import { fromBase58xrp, toBase58xrp } from '@exodus/bytes/base58.js'
 ```
 
-##### `fromBase58(str, format = 'uint8')`
-##### `toBase58(arr)`
+#### `fromBase58(string, format = 'uint8')`
+
+Decode a base58 string to bytes
 
-##### `fromBase58xrp(str, format = 'uint8')`
-##### `toBase58xrp(arr)`
+Uses the standard Bitcoin base58 alphabet
+
+#### `toBase58(arr)`
+
+Encode a `Uint8Array` to a base58 string
+
+Uses the standard Bitcoin base58 alphabet
+
+#### `fromBase58xrp(string, format = 'uint8')`
+
+Decode a base58 string to bytes using XRP alphabet
+
+Uses the XRP variant base58 alphabet
+
+#### `toBase58xrp(arr)`
+
+Encode a `Uint8Array` to a base58 string using XRP alphabet
+
+Uses the XRP variant base58 alphabet
 
 ### `@exodus/bytes/base58check.js`
 
+Implements [base58check](https://en.bitcoin.it/wiki/Base58Check_encoding) encoding.
+
 ```js
 import { fromBase58check, toBase58check } from '@exodus/bytes/base58check.js'
 import { fromBase58checkSync, toBase58checkSync } from '@exodus/bytes/base58check.js'
@@ -350,14 +529,38 @@ import { makeBase58check } from '@exodus/bytes/base58check.js'
 
 On non-Node.js, requires peer dependency [@noble/hashes](https://www.npmjs.com/package/@noble/hashes) to be installed.
 
-##### `async fromBase58check(str, format = 'uint8')`
-##### `async toBase58check(arr)`
-##### `fromBase58checkSync(str, format = 'uint8')`
-##### `toBase58checkSync(arr)`
-##### `makeBase58check(hashAlgo, hashAlgoSync)`
+#### `async fromBase58check(string, format = 'uint8')`
+
+Decode a base58check string to bytes asynchronously
+
+Validates the checksum using double SHA-256
+
+#### `async toBase58check(arr)`
+
+Encode bytes to base58check string asynchronously
+
+Uses double SHA-256 for checksum calculation
+
+#### `fromBase58checkSync(string, format = 'uint8')`
+
+Decode a base58check string to bytes synchronously
+
+Validates the checksum using double SHA-256
+
+#### `toBase58checkSync(arr)`
+
+Encode bytes to base58check string synchronously
+
+Uses double SHA-256 for checksum calculation
+
+#### `makeBase58check(hashAlgo, hashAlgoSync)`
+
+Create a base58check encoder/decoder with custom hash functions
 
 ### `@exodus/bytes/wif.js`
 
+Wallet Import Format (WIF) encoding and decoding.
+
 ```js
 import { fromWifString, toWifString } from '@exodus/bytes/wif.js'
 import { fromWifStringSync, toWifStringSync } from '@exodus/bytes/wif.js'
@@ -365,40 +568,83 @@ import { fromWifStringSync, toWifStringSync } from '@exodus/bytes/wif.js'
 
 On non-Node.js, requires peer dependency [@noble/hashes](https://www.npmjs.com/package/@noble/hashes) to be installed.
 
-##### `async fromWifString(string, version)`
-##### `fromWifStringSync(string, version)`
-##### `async toWifString({ version, privateKey, compressed })`
-##### `toWifStringSync({ version, privateKey, compressed })`
+#### `async fromWifString(string[, version])`
 
-### `@exodus/bytes/encoding.js`
+Decode a WIF string to WIF data
 
-```js
-import { TextDecoder, TextEncoder } from '@exodus/bytes/encoding.js'
-import { TextDecoderStream, TextEncoderStream } from '@exodus/bytes/encoding.js' // Requires Streams
+Returns a promise that resolves to an object with `{ version, privateKey, compressed }`.
 
-// Hooks for standards
-import { getBOMEncoding, legacyHookDecode, labelToName, normalizeEncoding } from '@exodus/bytes/encoding.js'
+The optional `version` parameter validates the version byte.
+
+Throws if the WIF string is invalid or version doesn't match.
+
+#### `fromWifStringSync(string[, version])`
+
+Decode a WIF string to WIF data (synchronous)
+
+Returns an object with `{ version, privateKey, compressed }`.
+
+The optional `version` parameter validates the version byte.
+
+Throws if the WIF string is invalid or version doesn't match.
+
+#### `async toWifString({ version, privateKey, compressed })`
+
+Encode WIF data to a WIF string
+
+#### `toWifStringSync({ version, privateKey, compressed })`
+
+Encode WIF data to a WIF string (synchronous)
+
+### `@exodus/bytes/array.js`
+
+TypedArray utils and conversions.
+
+```js
+import { typedView } from '@exodus/bytes/array.js'
 ```
 
+#### `typedView(arr, format = 'uint8')`
+
+Create a view of a TypedArray in the specified format (`'uint8'` or `'buffer'`)
+
+Important: does not copy data, returns a view on the same underlying buffer
+
+### `@exodus/bytes/encoding.js`
+
 Implements the [Encoding standard](https://encoding.spec.whatwg.org/):
 [TextDecoder](https://encoding.spec.whatwg.org/#interface-textdecoder),
 [TextEncoder](https://encoding.spec.whatwg.org/#interface-textencoder),
 [TextDecoderStream](https://encoding.spec.whatwg.org/#interface-textdecoderstream),
 [TextEncoderStream](https://encoding.spec.whatwg.org/#interface-textencoderstream),
-some [hooks](https://encoding.spec.whatwg.org/#specification-hooks) (see below).
+some [hooks](https://encoding.spec.whatwg.org/#specification-hooks).
+
+```js
+import { TextDecoder, TextEncoder } from '@exodus/bytes/encoding.js'
+import { TextDecoderStream, TextEncoderStream } from '@exodus/bytes/encoding.js' // Requires Streams
+
+// Hooks for standards
+import { getBOMEncoding, legacyHookDecode, labelToName, normalizeEncoding } from '@exodus/bytes/encoding.js'
+```
 
 #### `new TextDecoder(label = 'utf-8', { fatal = false, ignoreBOM = false })`
 
 [TextDecoder](https://encoding.spec.whatwg.org/#interface-textdecoder) implementation/polyfill.
 
+Decode bytes to strings according to [WHATWG Encoding](https://encoding.spec.whatwg.org) specification.
+
 #### `new TextEncoder()`
 
 [TextEncoder](https://encoding.spec.whatwg.org/#interface-textencoder) implementation/polyfill.
 
+Encode strings to UTF-8 bytes according to [WHATWG Encoding](https://encoding.spec.whatwg.org) specification.
+
 #### `new TextDecoderStream(label = 'utf-8', { fatal = false, ignoreBOM = false })`
 
 [TextDecoderStream](https://encoding.spec.whatwg.org/#interface-textdecoderstream) implementation/polyfill.
 
+A [Streams](https://streams.spec.whatwg.org/) wrapper for `TextDecoder`.
+
 Requires [Streams](https://streams.spec.whatwg.org/) to be either supported by the platform or
 [polyfilled](https://npmjs.com/package/web-streams-polyfill).
 
@@ -406,6 +652,8 @@ Requires [Streams](https://streams.spec.whatwg.org/) to be either supported by t
 
 [TextEncoderStream](https://encoding.spec.whatwg.org/#interface-textencoderstream) implementation/polyfill.
 
+A [Streams](https://streams.spec.whatwg.org/) wrapper for `TextEncoder`.
+
 Requires [Streams](https://streams.spec.whatwg.org/) to be either supported by the platform or
 [polyfilled](https://npmjs.com/package/web-streams-polyfill).
 
@@ -413,7 +661,7 @@ Requires [Streams](https://streams.spec.whatwg.org/) to be either supported by t
 
 Implements [get an encoding from a string `label`](https://encoding.spec.whatwg.org/#concept-encoding-get).
 
-Converts an encoding [label](https://encoding.spec.whatwg.org/#names-and-labels) to its name,
+Convert an encoding [label](https://encoding.spec.whatwg.org/#names-and-labels) to its name,
 as a case-sensitive string.
 
 If an encoding with that label does not exist, returns `null`.
@@ -422,7 +670,7 @@ All encoding names are also valid labels for corresponding encodings.
 
 #### `normalizeEncoding(label)`
 
-Converts an encoding [label](https://encoding.spec.whatwg.org/#names-and-labels) to its name,
+Convert an encoding [label](https://encoding.spec.whatwg.org/#names-and-labels) to its name,
 as an ASCII-lowercased string.
 
 If an encoding with that label does not exist, returns `null`.
@@ -445,10 +693,10 @@ All encoding names are also valid labels for corresponding encodings.
 Implements [BOM sniff](https://encoding.spec.whatwg.org/#bom-sniff) legacy hook.
 
 Given a `TypedArray` or an `ArrayBuffer` instance `input`, returns either of:
-* `'utf-8'`, if `input` starts with UTF-8 byte order mark.
-* `'utf-16le'`, if `input` starts with UTF-16LE byte order mark.
-* `'utf-16be'`, if `input` starts with UTF-16BE byte order mark.
-* `null` otherwise.
+- `'utf-8'`, if `input` starts with UTF-8 byte order mark.
+- `'utf-16le'`, if `input` starts with UTF-16LE byte order mark.
+- `'utf-16be'`, if `input` starts with UTF-16BE byte order mark.
+- `null` otherwise.
 
 #### `legacyHookDecode(input, fallbackEncoding = 'utf-8')`
 
@@ -461,10 +709,10 @@ decodes the `input` using that encoding, skipping BOM if it was present.
 
 Notes:
 
- * BOM-sniffed encoding takes precedence over `fallbackEncoding` option per spec.
-   Use with care.
- * Always operates in non-fatal [mode](https://encoding.spec.whatwg.org/#textdecoder-error-mode),
-   aka replacement. It can convert different byte sequences to equal strings.
+- BOM-sniffed encoding takes precedence over `fallbackEncoding` option per spec.
+  Use with care.
+- Always operates in non-fatal [mode](https://encoding.spec.whatwg.org/#textdecoder-error-mode),
+  aka replacement. It can convert different byte sequences to equal strings.
 
 This method is similar to the following code, except that it doesn't support encoding labels and
 only expects lowercased encoding name:
@@ -475,6 +723,10 @@ new TextDecoder(getBOMEncoding(input) ?? fallbackEncoding).decode(input)
 
 ### `@exodus/bytes/encoding-lite.js`
 
+The exact same exports as `@exodus/bytes/encoding.js` are also exported as
+`@exodus/bytes/encoding-lite.js`, with the difference that the lite version does not load
+multi-byte `TextDecoder` encodings by default to reduce bundle size 10x.
+
 ```js
 import { TextDecoder, TextEncoder } from '@exodus/bytes/encoding-lite.js'
 import { TextDecoderStream, TextEncoderStream } from '@exodus/bytes/encoding-lite.js' // Requires Streams
@@ -483,10 +735,6 @@ import { TextDecoderStream, TextEncoderStream } from '@exodus/bytes/encoding-lit
 import { getBOMEncoding, legacyHookDecode, labelToName, normalizeEncoding } from '@exodus/bytes/encoding-lite.js'
 ```
 
-The exact same exports as `@exodus/bytes/encoding.js` are also exported as
-`@exodus/bytes/encoding-lite.js`, with the difference that the lite version does not load
-multi-byte `TextDecoder` encodings by default to reduce bundle size 10x.
-
 The only affected encodings are: `gbk`, `gb18030`, `big5`, `euc-jp`, `iso-2022-jp`, `shift_jis`
 and their [labels](https://encoding.spec.whatwg.org/#names-and-labels) when used with `TextDecoder`.
 
@@ -534,6 +782,9 @@ true
 
 ### `@exodus/bytes/encoding-browser.js`
 
+Same as `@exodus/bytes/encoding.js`, but in browsers instead of polyfilling just uses whatever the
+browser provides, drastically reducing the bundle size (to less than 2 KiB gzipped).
+
 ```js
 import { TextDecoder, TextEncoder } from '@exodus/bytes/encoding-browser.js'
 import { TextDecoderStream, TextEncoderStream } from '@exodus/bytes/encoding-browser.js' // Requires Streams
@@ -542,9 +793,6 @@ import { TextDecoderStream, TextEncoderStream } from '@exodus/bytes/encoding-bro
 import { getBOMEncoding, legacyHookDecode, labelToName, normalizeEncoding } from '@exodus/bytes/encoding-browser.js'
 ```
 
-Same as `@exodus/bytes/encoding.js`, but in browsers instead of polyfilling just uses whatever the
-browser provides, drastically reducing the bundle size (to less than 2 KiB gzipped).
-
 Under non-browser engines (Node.js, React Native, etc.) a full polyfill is used as those platforms
 do not provide sufficiently complete / non-buggy `TextDecoder` APIs.
 
@@ -553,6 +801,10 @@ do not provide sufficiently complete / non-buggy `TextDecoder` APIs.
 > but they are fixing them and the expected update window is short.\
 > If you want to circumvent browser bugs, use full `@exodus/bytes/encoding.js` import.
 
+## Changelog
+
+See [GitHub Releases](https://github.com/ExodusOSS/bytes/releases) tab
+
 ## License
 
 [MIT](./LICENSE)