**PIOCHE IS IN ALPHA AND SHOULD NOT BE USED IN PRODUCTION**
TypeScript first framework for Cloudflare Workers enabling
Note: To use Durable Objects and Websockets features of Pioche, you need a Cloudflare account with Durable Objects access
- [x] Short development time
- [x] Decorator-based path-to-regexp router
- [x] Middleware support
- [x] Simplified, more powerful API for D/O Storage and KV
- [x] Simplified Worker -> D/O interaction
- [x] WebSocket handling
- [x] Minimized invokations and compute time
🔋 Tree Shakeable Batteries Available in pioche-extras
See the installation section of pioche-extras for prebuilt OAuth, log streaming, and middleware to use in your project
To get started use pioche-scripts
npx pioche-scripts create <AppName>
This will setup an minimal project with a single TypeScript file: helloworld.ts
We can then make changes to functionality and run
npm run build // Generate wrangler.toml and program entry point npm run dev // Deploy to Cloudflare with remote debugging session npm run serve // Run locally, debug locally npm run deploy // Deploy to Cloudflare
npm run deploy you should see
📕 Background and why Pioche Exists
Cloudflare (CF) workers platform has 3 major offerings:
Workers KV (KV): A non-transactional distributed key-value store
Workers are web-facing, D/Os are Workers-facing, KV Workers and D/O-facing.
Problem: There is a cumbersome dispatch process to call a D/O from a worker.
D/Os have an in-memory key value store (D/O storage)
Problem: This store has very similar capabilities but use a separate API from KV.
CPU time is charged per GB-sec, storage operations are charged per kB transferred, and Workers and D/Os are charged per invokation.
Problem: We want to only use D/Os when necessary and minimize CPU time and invokations.
Problem: There is no routing functionality
These 4 issues alone greatly increase upstart development time and complexity because orchestrating routing between services and resource management while minimizing cost is a huge task that developers shouldn't need to handle.
Pioche was created by Garrett Peake