refactor: comment the reader

linz · Jul 18, 2023 · 0590a20 · 0590a20
1 parent 132db97
commit 0590a20
Showing 1 changed file with 10 additions and 7 deletions.
diff --git a/packages/core/src/binary/binary.index.ts b/packages/core/src/binary/binary.index.ts
@@ -8,19 +8,22 @@ const Big32 = BigInt(32);
 const BigUint32Max = BigInt(2 ** 32 - 1);
 
 export function readMetadata(bytes: Uint8Array): CotarMetadata {
-  // Version as uint32
+  // Read the first three bytes as magic 'COT' string
+  const magic = String.fromCharCode(bytes[0]) + String.fromCharCode(bytes[1]) + String.fromCharCode(bytes[2]);
+
+  // Version number is a uint8
+  const version = bytes[3];
+
+  // Record count from uint32
   const byteA = bytes[4];
   const byteB = bytes[5] << 8;
   const byteC = bytes[6] << 16;
   const byteD = bytes[7] * 0x1000000;
-
-  const meta: CotarMetadata = {
-    magic: String.fromCharCode(bytes[0]) + String.fromCharCode(bytes[1]) + String.fromCharCode(bytes[2]),
-    version: bytes[3],
+  return {
+    magic,
+    version,
     count: (byteA | byteB | byteC) + byteD,
   };
-
-  return meta;
 }
 
 export type CotarMetadata = {