fix: better names

Author: vasco-santos

src/file/api.ts

@@ -14,7 +14,6 @@ import type { State } from "./writer.js"
 
 export * from "../writer/api.js"
 import * as ChunkerService from "./chunker.js"
-import init from "rabin-rs/gen/wasm.js"
 
 export type {
   Chunker,
@@ -74,10 +73,10 @@ export interface EncoderSettings<Layout extends unknown = unknown> {
 }
 
 export interface InitOptions {
-  linkMetadataWriter?: LinkMetadataWriter
+  unixFsFileLinkWriter?: UnixFsFileLinkWriter
 }
 
-export interface LinkMetadataWriter extends StreamWriter<UnixFS.FileLink> {}
+export interface UnixFsFileLinkWriter extends StreamWriter<UnixFS.FileLink> {}
 
 export interface Options<Layout = unknown> {
   writer: BlockWriter

src/file/writer.js

@@ -13,7 +13,7 @@ import * as Queue from "./layout/queue.js"
  * readonly metadata: UnixFS.Metadata
  * readonly config: API.EncoderSettings<Layout>
  * readonly writer: API.BlockWriter
- * readonly linkMetadataWriter?: API.LinkMetadataWriter
+ * readonly unixFsFileLinkWriter?: API.UnixFsFileLinkWriter
  * chunker: Chunker.Chunker
  * layout: Layout
  * nodeQueue: Queue.Queue
@@ -26,7 +26,7 @@ import * as Queue from "./layout/queue.js"
  * readonly metadata: UnixFS.Metadata
  * readonly config: API.EncoderSettings<Layout>
  * readonly writer: API.BlockWriter
- * readonly linkMetadataWriter?: API.LinkMetadataWriter
+ * readonly unixFsFileLinkWriter?: API.UnixFsFileLinkWriter
  * readonly rootID: Layout.NodeID
  * readonly end?: Task.Fork<void, never>
  * chunker?: null
@@ -41,7 +41,7 @@ import * as Queue from "./layout/queue.js"
  * readonly metadata: UnixFS.Metadata
  * readonly config: API.EncoderSettings<Layout>
  * readonly writer: API.BlockWriter
- * readonly linkMetadataWriter?: API.LinkMetadataWriter
+ * readonly unixFsFileLinkWriter?: API.UnixFsFileLinkWriter
  * readonly link: Layout.Link
  * chunker?: null
  * layout?: null
@@ -66,7 +66,7 @@ import * as Queue from "./layout/queue.js"
  * |{type:"write", bytes:Uint8Array}
  * |{type:"link", link:API.EncodedFile}
  * |{type:"block"}
- * |{type:"linkMetadata"}
+ * |{type:"fileLink"}
  * |{type: "close"}
  * |{type: "end"}
  * } Message
@@ -87,7 +87,7 @@ export const update = (message, state) => {
     case "block":
       return { state, effect: Task.none() }
     /* c8 ignore next 2 */
-    case "linkMetadata":
+    case "fileLink":
       return { state, effect: Task.none() }
     case "close":
       return close(state)
@@ -124,7 +124,7 @@ export const init = (writer, metadata, config, options = {}) => {
     // overhead.
     // @see https://github.com/Gozala/vectrie
     nodeQueue: Queue.mutable(),
-    linkMetadataWriter: options.linkMetadataWriter,
+    unixFsFileLinkWriter: options.unixFsFileLinkWriter,
   }
 }
 /**
@@ -197,7 +197,7 @@ export const link = (state, { id, link, block }) => {
       ? state.end.resume()
       : Task.none()
 
-  if (!state.linkMetadataWriter) {
+  if (!state.unixFsFileLinkWriter) {
     return {
       state: newState,
       effect: Task.listen({
@@ -213,7 +213,7 @@ export const link = (state, { id, link, block }) => {
     effect: Task.listen({
       link: Task.effects(tasks),
       block: writeBlock(state.writer, block),
-      linkMetadata: writeLinkMetadata(state.linkMetadataWriter, link),
+      fileLink: writeFileLink(state.unixFsFileLinkWriter, link),
       end,
     }),
   }
@@ -361,12 +361,12 @@ export const writeBlock = function* (writer, block) {
 }
 
 /**
- * @param {API.LinkMetadataWriter} writer
+ * @param {API.UnixFsFileLinkWriter} writer
  * @param {Layout.Link} link
  * @returns {Task.Task<void, never>}
  */
 
-export const writeLinkMetadata = function* (writer, link) {
+export const writeFileLink = function* (writer, link) {
   /* c8 ignore next 3 */
   if (!writer) {
     return

test/file.spec.js

@@ -62,23 +62,23 @@ describe("test file", () => {
 
     // Capture links metadata
     /** @type {import('../src/unixfs.js').FileLink[]} */
-    const linkMetadataItems = []
-    const { readable: linkMetadataReadable, writable: linkMetadataWritable } =
+    const fileLinkItems = []
+    const { readable: fileLinkReadable, writable: fileLinkWritable } =
       new TransformStream()
     // Start consuming links stream asynchronously
     void (async () => {
-      const reader = linkMetadataReadable.getReader()
+      const reader = fileLinkReadable.getReader()
       while (true) {
         const { done, value } = await reader.read()
         if (done) break
-        linkMetadataItems.push(value)
+        fileLinkItems.push(value)
       }
     })()
 
     const file = UnixFS.createFileWriter({
       writer,
       initOptions: {
-        linkMetadataWriter: linkMetadataWritable.getWriter(),
+        unixFsFileLinkWriter: fileLinkWritable.getWriter(),
       },
     })
     for (const rawFile of rawFiles) {
@@ -108,7 +108,7 @@ describe("test file", () => {
       r1.value.cid,
       Link.parse("bafybeihhsdoupgd3fnl3e3367ymsanmikafpllldsdt37jzyoh6nuatowe")
     )
-    const l1 = linkMetadataItems.find((l) => l.cid.equals(r1.value.cid))
+    const l1 = fileLinkItems.find((l) => l.cid.equals(r1.value.cid))
     assert.isTrue(l1 !== undefined)
     assert.equal(l1?.contentByteLength, CHUNK_SIZE)
     assert.equal(l1?.dagByteLength, CHUNK_SIZE + 14)
@@ -123,7 +123,7 @@ describe("test file", () => {
       r2.value.cid,
       Link.parse("bafybeief3dmadxfymhhhrflqytqmlhlz47w6glaxvyzmm6s6tpfb6izzee")
     )
-    const l2 = linkMetadataItems.find((l) => l.cid.equals(r2.value.cid))
+    const l2 = fileLinkItems.find((l) => l.cid.equals(r2.value.cid))
     assert.isTrue(l2 !== undefined)
     assert.equal(l2?.contentByteLength, CHUNK_SIZE)
     assert.equal(l2?.dagByteLength, CHUNK_SIZE + 14)
@@ -138,7 +138,7 @@ describe("test file", () => {
       r3.value.cid,
       Link.parse("bafybeihznihf5g5ibdyoawn7uu3inlyqrxjv63lt6lop6h3w6rzwrp67a4")
     )
-    const l3 = linkMetadataItems.find((l) => l.cid.equals(r3.value.cid))
+    const l3 = fileLinkItems.find((l) => l.cid.equals(r3.value.cid))
     assert.isTrue(l3 !== undefined)
     assert.equal(l3?.contentByteLength, CHUNK_SIZE)
     assert.equal(l3?.dagByteLength, CHUNK_SIZE + 14)
@@ -148,9 +148,9 @@ describe("test file", () => {
 
     // Check root
     assert.isTrue(
-      linkMetadataItems.find((l) => l.cid.equals(link.cid)) !== undefined
+      fileLinkItems.find((l) => l.cid.equals(link.cid)) !== undefined
     )
-    assert.equal(linkMetadataItems.length, 4)
+    assert.equal(fileLinkItems.length, 4)
   })
 
   it("--chunker=size-65535 --trickle=false --raw-leaves=false --cid-version=1", async () => {

test/sharded-directory.spec.js

@@ -98,7 +98,7 @@ describe("test directory", () => {
       contentByteOffset: 0,
     })
 
-    for (let i = 0 i < 100 i++) {
+    for (let i = 0; i < 100; i++) {
       root.set(`file${i}.txt`, fileLink)
     }