s/preferFloat32/forceFloat32/

gfx · gfx · commit 91eeb9845f5c · 2019-07-18T09:30:00.000+09:00
diff --git a/README.md b/README.md
@@ -114,7 +114,7 @@ extensionCodec | ExtensionCodec | `ExtensinCodec.defaultCodec`
 maxDepth | number | `100`
 initialBufferSize | number | `2048`
 sortKeys | boolean | false
-preferFloat32 | boolean | false
+forceFloat32 | boolean | false
 
 ### `decode(buffer: ArrayLike<number> | ArrayBuffer, options?: DecodeOptions): unknown`
 
diff --git a/src/Encoder.ts b/src/Encoder.ts
@@ -18,7 +18,7 @@ export class Encoder {
     readonly maxDepth = DEFAULT_MAX_DEPTH,
     readonly initialBufferSize = DEFAULT_INITIAL_BUFFER_SIZE,
     readonly sortKeys = false,
-    readonly preferFloat32 = false,
+    readonly forceFloat32 = false,
   ) {}
 
   encode(object: unknown, depth: number): void {
@@ -120,7 +120,7 @@ export class Encoder {
       }
     } else {
       // non-integer numbers
-      if (this.preferFloat32) {
+      if (this.forceFloat32) {
         // float 32
         this.writeU8(0xca);
         this.writeF32(object);
diff --git a/src/encode.ts b/src/encode.ts
@@ -9,9 +9,11 @@ export type EncodeOptions = Partial<
     sortKeys: boolean;
 
     /**
-     * If `true`, float32 is preferred in encoding non-integer numbers, insted of float64.
+     * If `true`, non-integer numbers are encoded in float32, not in float64 (the default).
+     *
+     * Only use it if precisions don't matter.
      */
-    preferFloat32: boolean;
+    forceFloat32: boolean;
   }>
 >;
 
@@ -29,7 +31,7 @@ export function encode(value: unknown, options: EncodeOptions = defaultEncodeOpt
     options.maxDepth,
     options.initialBufferSize,
     options.sortKeys,
-    options.preferFloat32,
+    options.forceFloat32,
   );
   encoder.encode(value, 1);
   return encoder.getUint8Array();
diff --git a/test/encode.test.ts b/test/encode.test.ts
@@ -8,18 +8,18 @@ describe("encode", () => {
     });
   });
 
-  context("preferFloat32", () => {
-    it("encodes numbers in float64 wihout preferFloat32", () => {
+  context("forceFloat32", () => {
+    it("encodes numbers in float64 wihout forceFloat32", () => {
       assert.deepStrictEqual(encode(3.14), Uint8Array.from([0xcb, 0x40, 0x9, 0x1e, 0xb8, 0x51, 0xeb, 0x85, 0x1f]));
     });
 
-    it("encodes numbers in float32 when preferFloate32=true", () => {
-      assert.deepStrictEqual(encode(3.14, { preferFloat32: true }), Uint8Array.from([0xca, 0x40, 0x48, 0xf5, 0xc3]));
+    it("encodes numbers in float32 when forceFloate32=true", () => {
+      assert.deepStrictEqual(encode(3.14, { forceFloat32: true }), Uint8Array.from([0xca, 0x40, 0x48, 0xf5, 0xc3]));
     });
 
-    it("encodes numbers in float64 with preferFloat32=false", () => {
+    it("encodes numbers in float64 with forceFloat32=false", () => {
       assert.deepStrictEqual(
-        encode(3.14, { preferFloat32: false }),
+        encode(3.14, { forceFloat32: false }),
         Uint8Array.from([0xcb, 0x40, 0x9, 0x1e, 0xb8, 0x51, 0xeb, 0x85, 0x1f]),
       );
     });
