Shared API

Common utilities and helpers used across ChunkFlow.

Event System

import { createEventBus } from "@chunkflowjs/shared";

const eventBus = createEventBus();

eventBus.on("event", (payload) => {
  console.log(payload);
});

eventBus.emit("event", { data: "value" });

Concurrency Control

import { ConcurrencyController } from "@chunkflowjs/shared";

const controller = new ConcurrencyController({ limit: 3 });

await controller.run(async () => {
  // Your async operation
});

File Utilities

sliceFile()

import { sliceFile } from "@chunkflowjs/shared";

const chunk = sliceFile(file, 0, 1024 * 1024); // First 1MB

calculateFileHash()

import { calculateFileHash } from "@chunkflowjs/shared";

const hash = await calculateFileHash(file, (progress) => {
  console.log(`Progress: ${progress}%`);
});

calculateChunkHash()

import { calculateChunkHash } from "@chunkflowjs/shared";

const hash = await calculateChunkHash(chunk);

formatFileSize()

import { formatFileSize } from "@chunkflowjs/shared";

console.log(formatFileSize(1024)); // "1.00 KB"
console.log(formatFileSize(1024 * 1024)); // "1.00 MB"

IndexedDB Storage

import { UploadStorage } from "@chunkflowjs/shared";

const storage = new UploadStorage();
await storage.init();

await storage.saveRecord(record);
const record = await storage.getRecord(taskId);
await storage.updateRecord(taskId, updates);
await storage.deleteRecord(taskId);

See Also

• Protocol API
• Core API