aboutsummaryrefslogtreecommitdiffstats
path: root/vanilla/node_modules/@exodus/bytes/encoding-browser.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'vanilla/node_modules/@exodus/bytes/encoding-browser.d.ts')
-rw-r--r--vanilla/node_modules/@exodus/bytes/encoding-browser.d.ts24
1 files changed, 24 insertions, 0 deletions
diff --git a/vanilla/node_modules/@exodus/bytes/encoding-browser.d.ts b/vanilla/node_modules/@exodus/bytes/encoding-browser.d.ts
new file mode 100644
index 0000000..565b43b
--- /dev/null
+++ b/vanilla/node_modules/@exodus/bytes/encoding-browser.d.ts
@@ -0,0 +1,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'