Merge pull request #123 from carbotaniuman/force_float

Add `forceFloat` option for integers

Author: gfx

README.md

@@ -118,6 +118,7 @@ maxDepth | number | `100`
 initialBufferSize | number | `2048`
 sortKeys | boolean | false
 forceFloat32 | boolean | false
+forceIntegerToFloat | boolean | false
 ignoreUndefined | boolean | false
 context | user-defined | -
 

src/Encoder.ts

@@ -20,6 +20,7 @@ export class Encoder<ContextType> {
     private readonly sortKeys = false,
     private readonly forceFloat32 = false,
     private readonly ignoreUndefined = false,
+    private readonly forceIntegerToFloat = false,
   ) {}
 
   private getUint8Array(): Uint8Array {
@@ -85,7 +86,7 @@ export class Encoder<ContextType> {
     }
   }
   private encodeNumber(object: number) {
-    if (Number.isSafeInteger(object)) {
+    if (Number.isSafeInteger(object) && !this.forceIntegerToFloat) {
       if (object >= 0) {
         if (object < 0x80) {
           // positive fixint

src/encode.ts

@@ -23,6 +23,14 @@ export type EncodeOptions<ContextType = undefined> = Partial<
      * The default is `false`. Note that it needs more time to encode.
      */
     ignoreUndefined: boolean;
+
+    /**
+     * If `true`, integer numbers are encoded as floating point,
+     * with the `forceFloat32` option taken into account.
+     *
+     * The default is `false`.
+     */
+    forceIntegerToFloat: boolean;
   }>
 > &
   ContextOf<ContextType>;
@@ -47,6 +55,7 @@ export function encode<ContextType>(
     options.sortKeys,
     options.forceFloat32,
     options.ignoreUndefined,
+    options.forceIntegerToFloat,
   );
   return encoder.encode(value);
 }

test/encode.test.ts

@@ -13,7 +13,7 @@ describe("encode", () => {
       assert.deepStrictEqual(encode(3.14), Uint8Array.from([0xcb, 0x40, 0x9, 0x1e, 0xb8, 0x51, 0xeb, 0x85, 0x1f]));
     });
 
-    it("encodes numbers in float32 when forceFloate32=true", () => {
+    it("encodes numbers in float32 when forceFloat32=true", () => {
       assert.deepStrictEqual(encode(3.14, { forceFloat32: true }), Uint8Array.from([0xca, 0x40, 0x48, 0xf5, 0xc3]));
     });
 
@@ -25,6 +25,30 @@ describe("encode", () => {
     });
   });
 
+  context("forceFloat", () => {
+    it("encodes integers as integers without forceIntegerToFloat", () => {
+      assert.deepStrictEqual(encode(3), Uint8Array.from([0x3]));
+    });
+
+    it("encodes integers as floating point when forceIntegerToFloat=true", () => {
+      assert.deepStrictEqual(
+        encode(3, { forceIntegerToFloat: true }),
+        Uint8Array.from([0xcb, 0x40, 0x08, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]),
+      );
+    });
+
+    it("encodes integers as float32 when forceIntegerToFloat=true and forceFloat32=true", () => {
+      assert.deepStrictEqual(
+        encode(3, { forceIntegerToFloat: true, forceFloat32: true }),
+        Uint8Array.from([0xca, 0x40, 0x40, 0x00, 0x00]),
+      );
+    });
+
+    it("encodes integers as integers when forceIntegerToFloat=false", () => {
+      assert.deepStrictEqual(encode(3, { forceIntegerToFloat: false }), Uint8Array.from([0x3]));
+    });
+  });
+
   context("ignoreUndefined", () => {
     it("encodes { foo: undefined } as is by default", () => {
       assert.deepStrictEqual(decode(encode({ foo: undefined, bar: 42 })), { foo: null, bar: 42 });