doc

Author: gfx

src/Encoder.ts

@@ -110,7 +110,7 @@ export class Encoder<ContextType = undefined> {
         }
       } else {
         if (object >= -0x20) {
-          // nagative fixint
+          // negative fixint
           this.writeU8(0xe0 | (object + 0x20));
         } else if (object >= -0x80) {
           // int 8

src/decode.ts

@@ -8,27 +8,32 @@ export type DecodeOptions<ContextType = undefined> = Readonly<
 
     /**
      * Maximum string length.
-     * Default to 4_294_967_295 (UINT32_MAX).
+     *
+     * Defaults to 4_294_967_295 (UINT32_MAX).
      */
     maxStrLength: number;
     /**
      * Maximum binary length.
-     * Default to 4_294_967_295 (UINT32_MAX).
+     *
+     * Defaults to 4_294_967_295 (UINT32_MAX).
      */
     maxBinLength: number;
     /**
      * Maximum array length.
-     * Default to 4_294_967_295 (UINT32_MAX).
+     *
+     * Defaults to 4_294_967_295 (UINT32_MAX).
      */
     maxArrayLength: number;
     /**
      * Maximum map length.
-     * Default to 4_294_967_295 (UINT32_MAX).
+     *
+     * Defaults to 4_294_967_295 (UINT32_MAX).
      */
     maxMapLength: number;
     /**
      * Maximum extension length.
-     * Default to 4_294_967_295 (UINT32_MAX).
+     *
+     * Defaults to 4_294_967_295 (UINT32_MAX).
      */
     maxExtLength: number;
   }>

src/encode.ts

@@ -5,30 +5,50 @@ import type { ContextOf, SplitUndefined } from "./context";
 export type EncodeOptions<ContextType = undefined> = Partial<
   Readonly<{
     extensionCodec: ExtensionCodecType<ContextType>;
+
+    /**
+     * The maximum depth in nested objects and arrays.
+     *
+     * Defaults to 100.
+     */
     maxDepth: number;
+
+    /**
+     * The initial size of the internal buffer.
+     *
+     * Defaults to 2048.
+     */
     initialBufferSize: number;
-    sortKeys: boolean;
 
+    /**
+     * If `true`, the keys of an object is sorted. In other words, the encoded
+     * binary is canonical and thus comparable to another encoded binary.
+     *
+     * Defaults to `false`. If enabled, it spends more time in encoding objects.
+     */
+    sortKeys: boolean;
     /**
      * If `true`, non-integer numbers are encoded in float32, not in float64 (the default).
      *
      * Only use it if precisions don't matter.
+     *
+     * Defaults to `false`.
      */
     forceFloat32: boolean;
 
     /**
      * If `true`, an object property with `undefined` value are ignored.
      * e.g. `{ foo: undefined }` will be encoded as `{}`, as `JSON.stringify()` does.
      *
-     * The default is `false`. Note that it needs more time to encode.
+     * Defaults to `false`. If enabled, it spends more time in encoding objects.
      */
     ignoreUndefined: boolean;
 
     /**
-     * If `true`, integer numbers are encoded as floating point,
+     * If `true`, integer numbers are encoded as floating point numbers,
      * with the `forceFloat32` option taken into account.
      *
-     * The default is `false`.
+     * Defaults to `false`.
      */
     forceIntegerToFloat: boolean;
   }>