@@ -230,6 +230,15 @@ import { windows1252toString, windows1252fromString } from '@exodus/bytes/single
230230import { latin1toString , latin1fromString } from ' @exodus/bytes/single-byte.js'
231231```
232232
233+ > [ !WARNING]
234+ > This is a lower-level API for single-byte encodings.
235+ > It might not match what you expect, as it supports both WHATWG and unicode.org encodings under
236+ > different names, with the main intended usecase for the latter being either non-web or legacy contexts.
237+ >
238+ > For a safe WHATWG Encoding-compatible API, see ` @exodus/bytes/encoding.js ` import (and variants of it).
239+ >
240+ > Be sure to know what you are doing and check documentation when directly using encodings from this file.
241+
233242Supports all single-byte encodings listed in the WHATWG Encoding standard:
234243` ibm866 ` , ` iso-8859-2 ` , ` iso-8859-3 ` , ` iso-8859-4 ` , ` iso-8859-5 ` , ` iso-8859-6 ` , ` iso-8859-7 ` , ` iso-8859-8 ` ,
235244` iso-8859-8-i ` , ` iso-8859-10 ` , ` iso-8859-13 ` , ` iso-8859-14 ` , ` iso-8859-15 ` , ` iso-8859-16 ` , ` koi8-r ` , ` koi8-u ` ,
@@ -341,6 +350,13 @@ Decode / encode the legacy multi-byte encodings according to the
341350import { createMultibyteDecoder , createMultibyteEncoder } from ' @exodus/bytes/multi-byte.js'
342351```
343352
353+ > [ !WARNING]
354+ > This is a lower-level API for legacy multi-byte encodings.
355+ >
356+ > For a safe WHATWG Encoding-compatible API, see ` @exodus/bytes/encoding.js ` import (and variants of it).
357+ >
358+ > Be sure to know what you are doing and check documentation when directly using encodings from this file.
359+
344360Supports all legacy multi-byte encodings listed in the WHATWG Encoding standard:
345361` gbk ` , ` gb18030 ` , ` big5 ` , ` euc-jp ` , ` iso-2022-jp ` , ` shift_jis ` , ` euc-kr ` .
346362
0 commit comments