Skip to content

Commit 33e2f20

Browse files
CopilotChALkeR
andcommitted
Improve documentation for SinglebyteEncoderOptions
Co-authored-by: ChALkeR <291301+ChALkeR@users.noreply.github.com>
1 parent 7b8bc55 commit 33e2f20

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

single-byte.d.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,10 @@ import type { Uint8ArrayBuffer } from './array.js';
2121
*/
2222
export interface SinglebyteEncoderOptions {
2323
/**
24-
* Encoding mode
25-
* - `'fatal'`: throw an error on unmapped characters (default)
24+
* Encoding mode (default: 'fatal')
25+
* - `'fatal'`: throw an error on unmapped characters
26+
*
27+
* Note: Currently, only 'fatal' mode is supported. Other modes will throw an error.
2628
*/
2729
mode?: 'fatal';
2830
}

0 commit comments

Comments
 (0)