Add rationale comments for write

swiftwasm · Aug 18, 2022 · 745f3c6 · 745f3c6
1 parent 7532e6a
commit 745f3c6
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/Runtime/src/js-value.ts b/Runtime/src/js-value.ts
@@ -70,6 +70,10 @@ export const decodeArray = (ptr: pointer, length: number, memory: Memory) => {
     return result;
 };
 
+// A helper function to encode a RawJSValue into a pointers.
+// Please prefer to use `writeAndReturnKindBits` to avoid unnecessary
+// memory stores.
+// This function should be used only when kind flag is stored in memory.
 export const write = (
     value: any,
     kind_ptr: pointer,