Documentation
This is the developer book for @bayudwiyansatria/cloudflare. The API reference is generated separately by TypeDoc from
the public surface in src/index.ts and src/middlewares/index.ts;
everything a generator cannot infer lives here.
The core library this package adapts is published as @bayudwiyansatria/core.
getting-started/
Enough to get a Worker reading and writing through these adapters.
| Doc | Covers |
|---|---|
| installation.md | Requirements, install, peer dependencies, the two published entries, and module resolution |
| quick-start.md | Declare the environment, register configuration, use a capability, wire the bindings |
guides/
How to operate or maintain a specific part of the project — task-oriented, step-by-step.
| Doc | Covers |
|---|---|
| migrating-from-boilerplate.md | Moving a Worker off a vendored src/core/ onto the two libraries |
| local-development.md | Install, link the kernel, build, watch, test, lint, format, and what each script actually runs |
| documentation.md | TypeDoc and HonKit, adding a page, keeping SUMMARY.md in sync, and the gate that fails a build |
| publishing.md | Versioning, the release dispatch, GitHub Packages, and exactly what ships in the tarball |
| docker.md | Building and serving this documentation site locally |
reference/
How the project is arranged — reference material, not a walkthrough.
| Doc | Covers |
|---|---|
| directory-structure.md | Every directory under src/, the Hono boundary, file naming, and the @/* import mapping |
| bindings.md | The eighteen binding accessors and their wrangler.json wiring |
| api-overview.md | The published surface at a glance, and the rule that decides what belongs in it |
release-notes/
Per-version release notes (1.0.0.md, …) — what shipped in each release.
changes-log/
Dated engineering change log (YYYY-MM-DD.md) — a more granular, chronological record of what changed and why,
continued per work session.
Historical docs (release-notes/, changes-log/) are point-in-time records and are not updated retroactively when the
codebase moves on. getting-started/, guides/, and reference/ are living docs — if you change the behavior they
describe, update them in the same change.