Server API

Server-side SDK for implementing upload services.

UploadService

Main service class for handling uploads.

import { UploadService, LocalStorageAdapter, PostgreSQLAdapter } from "@chunkflowjs/upload-server";

const service = new UploadService({
  storageAdapter: new LocalStorageAdapter("./storage"),
  database: new PostgreSQLAdapter(dbConfig),
  tokenSecret: "your-secret",
  defaultChunkSize: 1024 * 1024,
});

Methods

createFile()

const response = await service.createFile({
  fileName: "video.mp4",
  fileSize: 100 * 1024 * 1024,
  fileType: "video/mp4",
});

verifyHash()

const response = await service.verifyHash({
  fileHash: "abc123...",
  uploadToken: token,
});

uploadChunk()

const response = await service.uploadChunk({
  uploadToken: token,
  chunkIndex: 0,
  chunkHash: "chunk123...",
  chunk: buffer,
});

mergeFile()

const response = await service.mergeFile({
  uploadToken: token,
  fileHash: "abc123...",
  chunkHashes: ["chunk1...", "chunk2..."],
});

getFileStream()

const stream = await service.getFileStream(fileId);

Storage Adapters

LocalStorageAdapter

const storage = new LocalStorageAdapter("./storage");

OSSStorageAdapter

const storage = new OSSStorageAdapter({
  region: "oss-cn-hangzhou",
  accessKeyId: "key",
  accessKeySecret: "secret",
  bucket: "bucket",
});

Database Adapters

PostgreSQLAdapter

const database = new PostgreSQLAdapter({
  host: "localhost",
  port: 5432,
  database: "chunkflow",
  user: "postgres",
  password: "postgres",
});

See Also

• Server Configuration
• Storage Adapters
• Examples