Installation

Package Manager

ChunkFlow supports all major package managers. Choose the one you prefer:

pnpm (Recommended)

pnpm add @chunkflowjs/core

npm

npm install @chunkflowjs/core

yarn

yarn add @chunkflowjs/core

bun

bun add @chunkflowjs/core

Package Selection

Choose the packages based on your needs:

Minimal Setup (Core Only)

For vanilla JavaScript or custom integrations:

pnpm add @chunkflowjs/core

React Setup

For React applications with ready-to-use components:

pnpm add @chunkflowjs/core @chunkflowjs/upload-client-react @chunkflowjs/upload-component-react

Vue Setup

For Vue applications with ready-to-use components:

pnpm add @chunkflowjs/core @chunkflowjs/upload-client-vue @chunkflowjs/upload-component-vue

Server Setup

For Node.js server implementation:

pnpm add @chunkflowjs/upload-server

Full Stack Setup

For complete client and server setup:

# Client
pnpm add @chunkflowjs/core @chunkflowjs/upload-client-react @chunkflowjs/upload-component-react

# Server
pnpm add @chunkflowjs/upload-server

TypeScript Support

All ChunkFlow packages are written in TypeScript and include type definitions out of the box. No additional @types packages are needed.

Browser Support

ChunkFlow supports all modern browsers:

• Chrome/Edge 90+
• Firefox 88+
• Safari 14+

Required Browser APIs

ChunkFlow uses the following browser APIs:

• File API: For reading files
• Fetch API: For HTTP requests (or you can provide a custom adapter)
• IndexedDB: For resumable upload persistence (optional, gracefully degrades)
• Web Workers: For hash calculation (optional, falls back to main thread)

Node.js Support

For server-side usage:

• Node.js 18+
• Bun 1.0+

CDN Usage

You can also use ChunkFlow via CDN for quick prototyping:

<script type="module">
  import { UploadManager } from "https://esm.sh/@chunkflowjs/core";

  // Your code here
</script>

WARNING

CDN usage is not recommended for production. Use a package manager for better performance and reliability.

Monorepo Setup

If you're using a monorepo (pnpm workspace, npm workspaces, yarn workspaces, or Turborepo), ChunkFlow works seamlessly:

{
  "dependencies": {
    "@chunkflowjs/core": "workspace:*",
    "@chunkflowjs/upload-client-react": "workspace:*"
  }
}

Verification

After installation, verify that ChunkFlow is installed correctly:

import { UploadManager } from "@chunkflowjs/core";

console.log(UploadManager); // Should output the class constructor

Troubleshooting

Module Not Found

If you encounter "Module not found" errors:

1. Clear your package manager cache:

   pnpm store prune  # pnpm
   npm cache clean --force  # npm
   yarn cache clean  # yarn

2. Delete node_modules and reinstall:

   rm -rf node_modules
   pnpm install

TypeScript Errors

If you encounter TypeScript errors:

1. Ensure your tsconfig.json includes:

   {
     "compilerOptions": {
       "moduleResolution": "bundler",
       "module": "ESNext",
       "target": "ES2020"
     }
   }

2. Clear TypeScript cache:

   rm -rf node_modules/.cache

Build Errors

If you encounter build errors with Vite, Webpack, or other bundlers:

1. Ensure you're using ESM imports
2. Check that your bundler supports the exports field in package.json
3. Update your bundler to the latest version

Next Steps

Now that you have ChunkFlow installed, check out the Getting Started guide to begin using it in your project.