fix: stringify should respect Buffer.from default encoding

EqualMa · Aug 15, 2020 · 44f5b5d · 44f5b5d
1 parent af512f3
commit 44f5b5d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -92,7 +92,8 @@ export interface JsonLinesStringifyOptions<V> {
    * NOTE that [the standard jsonlines](http://jsonlines.org/)
    * requires `utf8` as file encoding
    *
-   * Defaults to `utf8`
+   * Defaults to `Buffer.from` default encoding,
+   * which is `utf8`.
    */
   encoding?: BufferEncoding;
 

diff --git a/src/stringify.ts b/src/stringify.ts
@@ -10,7 +10,8 @@ export interface JsonLinesStringifyOptions<V> {
    * NOTE that [the standard jsonlines](http://jsonlines.org/)
    * requires `utf8` as file encoding
    *
-   * Defaults to `utf8`
+   * Defaults to `Buffer.from` default encoding,
+   * which is `utf8`.
    */
   encoding?: BufferEncoding;
 
@@ -46,15 +47,15 @@ export interface JsonLinesStringifyOptions<V> {
 export class JsonLinesStringifyStream<V> extends Transform {
   #stringify: (v: V) => string | Promise<string>;
 
-  readonly encoding: BufferEncoding;
+  readonly encoding: BufferEncoding | undefined;
   readonly lineSep: string;
 
   constructor(options?: JsonLinesStringifyOptions<V>) {
     super({
       writableObjectMode: true,
     });
 
-    this.encoding = options?.encoding ?? "utf8";
+    this.encoding = options?.encoding;
     this.lineSep = getLineSepString(options?.lineSep ?? "lf");
     this.#stringify = options?.stringify ?? JSON.stringify;
   }