[encoding] Add annotations that toUint8Array should only be called on…

…ce. closes #60
dmonad · Nov 22, 2023 · cac4215 · cac4215
1 parent 00fbf0b
commit cac4215
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/encoding.js b/encoding.js
@@ -762,6 +762,11 @@ export class UintOptRleEncoder {
     }
   }
 
+  /**
+   * Flush the encoded state and transform this to a Uint8Array.
+   *
+   * Note that this should only be called once.
+   */
   toUint8Array () {
     flushUintOptRleEncoder(this)
     return toUint8Array(this.encoder)
@@ -799,6 +804,11 @@ export class IncUintOptRleEncoder {
     }
   }
 
+  /**
+   * Flush the encoded state and transform this to a Uint8Array.
+   *
+   * Note that this should only be called once.
+   */
   toUint8Array () {
     flushUintOptRleEncoder(this)
     return toUint8Array(this.encoder)
@@ -866,6 +876,11 @@ export class IntDiffOptRleEncoder {
     }
   }
 
+  /**
+   * Flush the encoded state and transform this to a Uint8Array.
+   *
+   * Note that this should only be called once.
+   */
   toUint8Array () {
     flushIntDiffOptRleEncoder(this)
     return toUint8Array(this.encoder)