aboutsummaryrefslogtreecommitdiffstats
path: root/vanilla/node_modules/@exodus/bytes/encoding-browser.d.ts
blob: 565b43b1adeb0fad3b27f1095e1dd37bdd73922e (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
/**
 * 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
 *
 * // Hooks for standards
 * import { getBOMEncoding, legacyHookDecode, labelToName, normalizeEncoding } from '@exodus/bytes/encoding-browser.js'
 * ```
 *
 * 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.
 *
 * > [!NOTE]
 * > Implementations in browsers [have bugs](https://docs.google.com/spreadsheets/d/1pdEefRG6r9fZy61WHGz0TKSt8cO4ISWqlpBN5KntIvQ/edit),
 * > 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.
 *
 * @module @exodus/bytes/encoding-browser.js
 */

export * from './encoding.js'