","directories":{},"_nodeVersion":"20.2.0","_hasShrinkwrap":false,"devDependencies":{"bun-types":"^0.5.0","@types/node":"^20.0.0"},"_npmOperationalInternal":{"tmp":"tmp/spooder_3.0.1_1685526245463_0.9257577736353066","host":"s3://npm-registry-packages"}},"3.0.2":{"name":"spooder","version":"3.0.2","_id":"spooder@3.0.2","maintainers":[{"name":"kruithne","email":"kruithne@gmail.com"}],"bin":{"spooder":"bun run ./src/cli.ts"},"dist":{"shasum":"1ce0c2a0a53f8260c12c0a9e418f5543989ff5b6","tarball":"https://registry.npmjs.org/spooder/-/spooder-3.0.2.tgz","fileCount":8,"integrity":"sha512-5K4ftFeelHc+FSpWT0qdsDJA0S7vs62+T428SnlPz7dA63Uk9L/af12suzE/oRQwC5erjnouuDevwlsKk9bB0g==","signatures":[{"sig":"MEQCIE4yA90Hdg0+BtZb98jvL3pk0SSJ3YNAv4BZWeSoYvPpAiBZB8n2t7QhV65XxWjUcQU21YCp9A00+FietK0NqSO6EA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":7798},"type":"module","module":"./src/api.ts","exports":{".":{"bun":"./src/api.ts","import":"./src/api.ts"}},"gitHead":"8909d4e5fd8af58b594fc8c56c12d18355049d09","_npmUser":{"name":"kruithne","email":"kruithne@gmail.com"},"_npmVersion":"9.6.6","description":"
","directories":{},"_nodeVersion":"20.2.0","_hasShrinkwrap":false,"devDependencies":{"bun-types":"^0.5.0","@types/node":"^20.0.0"},"_npmOperationalInternal":{"tmp":"tmp/spooder_3.0.2_1685538090927_0.29019277336048854","host":"s3://npm-registry-packages"}},"3.0.3":{"name":"spooder","version":"3.0.3","_id":"spooder@3.0.3","maintainers":[{"name":"kruithne","email":"kruithne@gmail.com"}],"bin":{"spooder":"bun run ./src/cli.ts"},"dist":{"shasum":"6fa3c77272fb79ee783ff732af78d30495ef4a24","tarball":"https://registry.npmjs.org/spooder/-/spooder-3.0.3.tgz","fileCount":9,"integrity":"sha512-u8DqPMg1IfnHrwsNbyVc1goV7KrhbWiDnLUcdMhGJiC2wtE79ml4jqXnNU5TNH2zbY/FvWvxowmFpJht1m5QOw==","signatures":[{"sig":"MEQCIDr5gpGNWAzxhhmtJpbiHL67YNOtwoj773DauPneaMPIAiBAn5zwk1Flzn58cv8RPF2CK5Md6lB9HKzG0typ0avNvA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":9236},"type":"module","module":"./src/api.ts","exports":{".":{"bun":"./src/api.ts","import":"./src/api.ts"}},"gitHead":"9de1e9e11914e28573b2812f7fd028254246616e","_npmUser":{"name":"kruithne","email":"kruithne@gmail.com"},"_npmVersion":"9.6.6","description":"
","directories":{},"_nodeVersion":"20.2.0","_hasShrinkwrap":false,"devDependencies":{"bun-types":"^0.5.0","@types/node":"^20.0.0"},"_npmOperationalInternal":{"tmp":"tmp/spooder_3.0.3_1685539225079_0.6669883904988867","host":"s3://npm-registry-packages"}},"3.0.4":{"name":"spooder","version":"3.0.4","_id":"spooder@3.0.4","maintainers":[{"name":"kruithne","email":"kruithne@gmail.com"}],"bin":{"spooder":"bun run ./src/cli.ts"},"dist":{"shasum":"a11353f0474ee32233dffd1828ee8c11d4fd07e9","tarball":"https://registry.npmjs.org/spooder/-/spooder-3.0.4.tgz","fileCount":8,"integrity":"sha512-13/P+AMME6K+kfq6MqAJKNjUBpiduawSpNdNk3ivtod0Z5OO5CChxkNTI0FEfTBg1yea2fyZ2FFYJ5npKk09vQ==","signatures":[{"sig":"MEQCIG1/XZ2i5GzmgAx6eLppj8CIvouIeMG3m2hGzvFNbkYAAiAIVrU4QANgHJWEe2XB6lKJPQokfgAfkj//NtFliu9brw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":7713},"type":"module","module":"./src/api.ts","gitHead":"d59f42b36ce2f2c4808d8ee2e792c2a4c8d961d7","_npmUser":{"name":"kruithne","email":"kruithne@gmail.com"},"_npmVersion":"9.6.6","description":"
","directories":{},"_nodeVersion":"20.2.0","_hasShrinkwrap":false,"devDependencies":{"bun-types":"^0.5.0","@types/node":"^20.0.0"},"_npmOperationalInternal":{"tmp":"tmp/spooder_3.0.4_1685539938372_0.8368275609926599","host":"s3://npm-registry-packages"}},"3.0.5":{"name":"spooder","version":"3.0.5","_id":"spooder@3.0.5","maintainers":[{"name":"kruithne","email":"kruithne@gmail.com"}],"bin":{"cheese":"echo \"cheese\"","spooder":"bun run ./src/cli.ts"},"dist":{"shasum":"d95c4f9245b9304661970ccfa7ee0ac856b74d57","tarball":"https://registry.npmjs.org/spooder/-/spooder-3.0.5.tgz","fileCount":8,"integrity":"sha512-1hcvmM+osHhhxemjj+t44jkFs9fvbXAiAkN7EmAJCR7FIyd2IiDRnIwqDsi9TGnIqx7LZycgaoKpdTC5sONU0A==","signatures":[{"sig":"MEUCIQDjkf4U9LX+Vlj1S/3j++4TN4jubPJ5bNLovFTCO99/awIgfWt47nkHPWyq2DM1PEPtaYQYfl6euGcdtgvCgrqfBAE=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":7829},"type":"module","module":"./src/api.ts","exports":{".":{"bun":"./src/api.ts","import":"./src/api.ts"}},"gitHead":"bc115aa818a22146615ff59027530244ae9e8c3d","_npmUser":{"name":"kruithne","email":"kruithne@gmail.com"},"_npmVersion":"9.6.6","description":"
\n\n# spooder ·  [](LICENSE)  \n\n`spooder` is a purpose-built server solution that shifts away from the dependency hell of the Node.js ecosystem, with a focus on stability and performance, which is why:\n- It is built using the [Bun](https://bun.sh/) runtime and not designed to be compatible with Node.js or other runtimes.\n- It uses zero dependencies and only relies on code written explicitly for `spooder` or APIs provided by the Bun runtime, often implemented in native code.\n- It provides streamlined APIs for common server tasks in a minimalistic way, without the overhead of a full-featured web framework.\n- It is opinionated in its design to reduce complexity and overhead.\n\nThe design goal behind `spooder` is not to provide a full-featured web server, but to expand the Bun runtime with a set of APIs and utilities that make it easy to develop servers with minimal overhead.\n\n### spooderverse\nIn addition to the core API provided here, you can also find [spooderverse](https://github.com/Kruithne/spooderverse) which is a collection of drop-in modules designed for spooder with minimal overhead and zero dependencies.\n\n> [!NOTE]\n> If you think a is missing a feature, consider opening an issue with your use-case. The goal behind `spooder` is to provide APIs that are useful for a wide range of use-cases, not to provide bespoke features better suited for userland.\n\nIt consists of two components, the `CLI` and the `API`. \n- The `CLI` is responsible for keeping the server process running, applying updates in response to source control changes, and automatically raising issues on GitHub via the canary feature.\n- The `API` provides a minimal building-block style API for developing servers, with a focus on simplicity and performance.\n\n# Installation\n\n```bash\n# Installing globally for CLI runner usage.\nbun add spooder --global\n\n# Install into local package for API usage.\nbun add spooder\n```\n\n# Configuration\n\nBoth the `CLI` and the API are configured in the same way by providing a `spooder` object in your `package.json` file.\n\nBelow is a full map of the available configuration options in their default states. All configuration options are **optional**.\n\n```jsonc\n{\n\t\"spooder\": {\n\n\t\t// see CLI > Usage\n\t\t\"run\": \"\",\n\t\t\"run_dev\": \"\",\n\n\t\t// see CLI > Auto Restart\n\t\t\"auto_restart\": {\n\t\t\t\"enabled\": false,\n\t\t\t\"backoff_max\": 300000,\n\t\t\t\"backoff_grace\": 30000,\n\t\t\t\"max_attempts\": -1\n\t\t},\n\n\t\t// see CLI > Instancing > Rolling Restart\n\t\t\"rolling_restart_delay\": 0,\n\n\t\t// see CLI > Auto Update\n\t\t\"update\": [\n\t\t\t\"git pull\",\n\t\t\t\"bun install\"\n\t\t],\n\n\t\t// see CLI > Setup Scripts\n\t\t\"setup\": [\n\t\t\t\"scripts/seed_db.ts\",\n\t\t\t\"scripts/register_webhooks.ts\"\n\t\t],\n\n\t\t// see CLI > Canary\n\t\t\"canary\": {\n\t\t\t\"enabled\": false,\n\t\t\t\"account\": \"\",\n\t\t\t\"repository\": \"\",\n\t\t\t\"labels\": [],\n\t\t\t\"crash_console_history\": 64,\n\t\t\t\"throttle\": 86400,\n\t\t\t\"sanitize\": true\n\t\t},\n\n\t\t// see CLI > Logging\n\t\t\"logging\": {\n\t\t\t\"enabled\": false,\n\t\t\t\"directory\": \"logs\",\n\t\t\t\"max_size\": 10485760,\n\t\t\t\"max_files\": 3\n\t\t}\n\t}\n}\n```\n\nIf there are any issues with the provided configuration, a warning will be printed to the console but will not halt execution. `spooder` will always fall back to default values where invalid configuration is provided.\n\n> [!NOTE]\n> Configuration warnings **do not** raise `caution` events with the `spooder` canary functionality.\n\n# CLI\n\nThe `CLI` component of `spooder` is a global command-line tool for running server processes.\n\n- [CLI > Usage](#cli-usage)\n- [CLI > Dev Mode](#cli-dev-mode)\n- [CLI > Auto Restart](#cli-auto-restart)\n- [CLI > Auto Update](#cli-auto-update)\n- [CLI > Setup Scripts](#cli-setup-scripts)\n- [CLI > Instancing](#cli-instancing)\n- [CLI > Canary](#cli-canary)\n\t- [CLI > Canary > Crash](#cli-canary-crash)\n\t- [CLI > Canary > Sanitization](#cli-canary-sanitization)\n\t- [CLI > Canary > System Information](#cli-canary-system-information)\n- [CLI > Logging](#cli-logging)\n\n# API\n\n`spooder` exposes a simple yet powerful API for developing servers. The API is designed to be minimal to leave control in the hands of the developer and not add overhead for features you may not need.\n\n- [API > Cheatsheet](#api-cheatsheet)\n- [API > Logging](#api-logging)\n- [API > IPC](#api-ipc)\n- [API > HTTP](#api-http)\n\t- [API > HTTP > Directory Serving](#api-http-directory)\n\t- [API > HTTP > Server-Sent Events (SSE)](#api-http-sse)\n\t- [API > HTTP > Webhooks](#api-http-webhooks)\n\t- [API > HTTP > Websocket Server](#api-http-websockets)\n\t- [API > HTTP > Bootstrap](#api-http-bootstrap)\n\t- [API > HTTP > Cookies](#api-http-cookies)\n- [API > Error Handling](#api-error-handling)\n- [API > Workers](#api-workers)\n- [API > Caching](#api-caching)\n- [API > Templating](#api-templating)\n- [API > Cache Busting](#api-cache-busting)\n- [API > Git](#api-git)\n- [API > Database](#api-database)\n\t- [API > Database > Utilities](#api-database-utilities)\n\t- [API > Database > Schema](#api-database-schema)\n- [API > Utilities](#api-utilities)\n\n# CLI\n\n\n## CLI > Usage\n\nFor convenience, it is recommended that you run this in a `screen` session.\n\n```bash\nscreen -S my-website-about-fish.net\ncd /var/www/my-website-about-fish.net/\nspooder\n```\n\n`spooder` will launch your server either by executing the `run` command provided in the configuration. If this is not defined, an error will be thrown.\n\n```json\n{\n\t\"spooder\": {\n\t\t\"run\": \"bun run my_server.ts\"\n\t}\n}\n```\n\nWhile `spooder` uses a `bun run` command by default, it is possible to use any command string. For example if you wanted to launch a server using `node` instead of `bun`, you could do the following.\n\n```json\n{\n\t\"spooder\": {\n\t\t\"run\": \"node my_server.js\"\n\t}\n}\n```\n\n\n## CLI > Dev Mode\n\n`spooder` can be started in development mode by providing the `--dev` flag when starting the server.\n\n```bash\nspooder --dev\n```\n\nThe following differences will be observed when running in development mode:\n\n- If `run_dev` is configured, it will be used instead of the default `run` command.\n- Update commands defined in `spooder.update` will not be executed when starting a server.\n- If the server crashes and `auto_restart` is configured, the server will not be restarted, and spooder will exit with the same exit code as the server.\n- Setup scripts defined in `spooder.setup` will still run in dev mode (unlike update commands), since provisioning is needed in all environments. The `.spooder` state file prevents re-runs regardless.\n- If canary is configured, reports will not be dispatched to GitHub and instead be printed to the console; this includes crash reports.\n\nIt is possible to detect in userland if a server is running in development mode by checking the `SPOODER_ENV` environment variable.\n\n```ts\nif (process.env.SPOODER_ENV === 'dev') {\n\t// Server is running in development mode.\n}\n```\n\n### Development Command Override\n\nYou can configure a different command to run when in development mode using the `run_dev` option:\n\n```json\n{\n\t\"spooder\": {\n\t\t\"run\": \"bun run server.ts\",\n\t\t\"run_dev\": \"bun run server.ts --inspect\"\n\t}\n}\n```\n\n> [!NOTE]\n> `SPOODER_ENV` should be either `dev` or `prod`. If the variable is not defined, the server was not started by the `spooder` CLI.\n\n\n## CLI > Auto Restart\n\n> [!NOTE]\n> This feature is not enabled by default.\n\nIn the event that the server process exits, `spooder` can automatically restart it.\n\nIf the server exits with a non-zero exit code, this will be considered an **unexpected shutdown**. The process will be restarted using an [exponential backoff strategy](https://en.wikipedia.org/wiki/Exponential_backoff).\n\n```json\n{\n\t\"spooder\": {\n\t\t\"auto_restart\": {\n\t\t\t\"enabled\": true,\n\n\t\t\t// max restarts before giving up\n\t\t\t\"max_attempts\": -1, // default (unlimited)\n\n\t\t\t// max delay (ms) between restart attempts\n\t\t\t\"backoff_max\": 300000, // default 5 min\n\n\t\t\t// grace period after which the backoff protocol\n\t\t\t\"backoff_grace\": 30000 // default 30s\n\t\t}\n\t}\n}\n```\n\nIf the server exits with a `0` exit code, this will be considered an **intentional shutdown** and `spooder` will execute the update commands before restarting the server.\n\n> [!TIP]\n> An **intentional shutdown** can be useful for auto-updating in response to events, such as webhooks.\n\nIf the server exits with `42` (SPOODER_AUTO_RESTART), the update commands will **not** be executed before starting the server. [See Auto Update for information](#cli-auto-update).\n\n\n## CLI > Auto Update\n\n> [!NOTE]\n> This feature is not enabled by default.\n\nWhen starting or restarting a server process, `spooder` can automatically update the source code in the working directory. To enable this feature, the necessary update commands can be provided in the configuration as an array of strings.\n\n```json\n{\n\t\"spooder\": {\n\t\t\"update\": [\n\t\t\t\"git reset --hard\",\n\t\t\t\"git clean -fd\",\n\t\t\t\"git pull origin main\",\n\t\t\t\"bun install\"\n\t\t]\n\t}\n}\n```\n\nEach command should be a separate entry in the array and will be executed in sequence. The server process will be started once all commands have resolved.\n\n> [!IMPORTANT]\n> Chaining commands using `&&` or `||` operators does not work.\n\nIf a command in the sequence fails, the remaining commands will not be executed, however the server will still be started. This is preferred over entering a restart loop or failing to start the server at all.\n\nYou can combine this with [Auto Restart](#cli-auto-restart) to automatically update your server in response to a webhook by exiting the process.\n\n```ts\nserver.webhook(process.env.WEBHOOK_SECRET, '/webhook', payload => {\n\tsetImmediate(async () => {\n\t\tawait server.stop(false);\n\t\tprocess.exit(0);\n\t});\n\treturn HTTP_STATUS_CODE.OK_200;\n});\n```\n\n### Multi-Instance Auto Update\n\nSee [Instancing](#cli-instancing) for instructions on how to use [Auto Update](#cli-auto-update) with multiple instances.\n\n### Skip Updates\n\nIn addition to being skipped in [dev mode](#cli-dev-mode), updates can also be skipped in production mode by passing the `--no-update` flag.\n\n\n## CLI > Setup Scripts\n\n> [!NOTE]\n> This feature is not enabled by default.\n\nSetup scripts are one-off provisioning tasks (database seeding, webhook registration, directory creation) that need to run once when deploying to a new machine. They are executed sequentially via `bun run` in the project root.\n\n```json\n{\n\t\"spooder\": {\n\t\t\"setup\": [\n\t\t\t\"scripts/seed_db.ts\",\n\t\t\t\"scripts/register_webhooks.ts\"\n\t\t]\n\t}\n}\n```\n\nCompleted scripts are tracked in a `.spooder` file in the project root. Scripts that have already been completed are skipped on subsequent startups. You should add `.spooder` to your `.gitignore` since it is machine-specific state.\n\n> [!IMPORTANT]\n> If a setup script fails (non-zero exit code), the error will be logged and a canary report dispatched (if configured), but the server will still start. Failed scripts are **not** marked as completed and will be retried on the next startup.\n\n### Skip Setup Scripts\n\nSetup scripts can be skipped by passing the `--no-setup` flag.\n\n\n## CLI > Instancing\n\n> [!NOTE]\n> This feature is not enabled by default.\n\nBy default, `spooder` will start and manage a single process as defined by the `run` and `run_dev` configuration properties. In some scenarios, you may want multiple processes for a single codebase, such as variant sub-domains.\n\nThis can be configured in `spooder` using the `instances` array, with each entry defining a unique instance.\n\n```json\n\"spooder\": {\n\t\"instances\": [\n\t\t{\n\t\t\t\"id\": \"dev01\",\n\t\t\t\"run\": \"bun run --env-file=.env.a index.ts\",\n\t\t\t\"run_dev\": \"bun run --env-file=.env.a.dev index.ts --inspect\"\n\t\t},\n\t\t{\n\t\t\t\"id\": \"dev02\",\n\t\t\t\"run\": \"bun run --env-file=.env.b index.ts\",\n\t\t\t\"run_dev\": \"bun run --env-file=.env.b.dev index.ts --inspect\"\n\t\t}\n\t]\n}\n```\n\nInstances will be managed individually in the same manner that a single process would be, including auto-restarting and other functionality.\n\n### Instance Environment\n\nEach instance can define custom environment variables using the `env` property. These variables are merged with the parent process environment and passed to the spawned instance.\n\n```json\n\"spooder\": {\n\t\"instances\": [\n\t\t{\n\t\t\t\"id\": \"foo\",\n\t\t\t\"run\": \"bun run server.ts\",\n\t\t\t\"env\": { \"ENVTEST\": \"foo\" }\n\t\t},\n\t\t{\n\t\t\t\"id\": \"bar\",\n\t\t\t\"run\": \"bun run server.ts\",\n\t\t\t\"env\": { \"ENVTEST\": \"bar\" }\n\t\t}\n\t]\n}\n```\n\nEnvironment variable precedence (highest to lowest):\n1. `SPOODER_ENV` - always set by spooder (`dev` or `prod`)\n2. Instance `env` - overrides parent environment\n3. Parent process environment - inherited from spooder\n\n### Instance Stagger\n\nBy default, instances are all launched instantly. This behavior can be configured with the `instance_stagger_interval` configuration property, which defines an interval between instance launches in milliseconds.\n\nThis interval effects both server start-up, auto-restarting and crash recovery. No two instances will be launched within that interval regardless of the reason.\n\n### Rolling Restart\n\nBy default, when an update is triggered via IPC (`CMSG_TRIGGER_UPDATE`), all instances are signaled to restart simultaneously. This can cause resource spikes on the server when all instances reinitialize at the same time.\n\nThe `rolling_restart_delay` configuration property (in milliseconds) enables rolling restarts, where instances are signaled one at a time with a delay between each.\n\n```json\n{\n\t\"spooder\": {\n\t\t\"rolling_restart_delay\": 120000\n\t}\n}\n```\n\nIn this example, each instance is signaled to restart with a 2-minute gap, ensuring only one instance is reinitializing at any given time.\n\nWhen `rolling_restart_delay` is set to `0` (default), all instances are signaled simultaneously as before.\n\n#### Overlapping Updates\n\nIf a new update is triggered while a rolling restart is already in progress, the update commands are not run immediately. Instead, the update is queued and a new rollout (including update commands) begins automatically after the current rollout completes. This ensures all instances converge to the latest version without conflicting update operations.\n\n### Canary\n\nThe [canary](#cli-canary) feature functions the same for multiple instances as it would for a single instance with the caveat that the `instance` object as defined in the configuration is included in the crash report for diagnostics.\n\nThis allows you to define custom properties on the instance which will be included as part of the crash report.\n\n```json\n{\n\t\"id\": \"dev01\",\n\t\"run\": \"bun run --env-file=.env.a index.ts\",\n\t\"sub_domain\": \"dev01.spooder.dev\" // custom, for diagnostics\n}\n```\n\n> ![IMPORTANT]\n> You should not include sensitive or confidential credentials in your instance configuration for this reason. This should always be handled using environment variables or credential storage.\n\n### Multi-instance Auto Restart\n\nCombining [Auto Restart](#cli-auto-restart) and [Auto Update](#cli-auto-update), when a server process exits with a zero exit code, the update commands will be run as the server restarts. This is suitable for a single-instance setup.\n\nIn the event of multiple instances, this does not work. One server instance would receive the webhook and exit, resulting in the update commands being run and that instance being restarted, leaving the other instances still running.\n\nA solution might be to send the web-hook to every instance, but now each instance is going to restart individually, running the update commands unnecessarily and, if at the same time, causing conflicts. In addition, the concept of multiple instances in spooder is that they operate from a single codebase, which makes sending multiple webhooks a challenge - so don't do this.\n\nThe solution is to the use the [IPC](#api-ipc) to instruct the host process to handle this.\n\n```ts\nserver.webhook(process.env.WEBHOOK_SECRET, '/webhook', payload => {\n\tsetImmediate(async () => {\n\t\tipc_send(IPC_TARGET.SPOODER, IPC_OP.CMSG_TRIGGER_UPDATE);\n\t});\n\treturn HTTP_STATUS_CODE.OK_200;\n});\n\nipc_register(IPC_OP.SMSG_UPDATE_READY, async () => {\n\tawait server.stop(false);\n\tprocess.exit(EXIT_CODE.SPOODER_AUTO_UPDATE);\n});\n```\n\nIn this scenario, we instruct the host process from one instance receiving the webhook to apply the updates. Once the update commands have been run, all instances are sent the `SMSG_UPDATE_READY` event, indicating they can restart.\n\nExiting with the `SPOODER_AUTO_UPDATE` exit code instructs spooder that we're exiting as part of this process, and prevents auto-update from running on restart.\n\n> [!TIP]\n> Combine this with [Rolling Restart](#rolling-restart) to stagger the restart signals across instances, reducing resource spikes during deployments.\n\n\n## CLI > Canary\n\n> [!NOTE]\n> This feature is not enabled by default.\n\n`canary` is a feature in `spooder` which allows server problems to be raised as issues in your repository on GitHub.\n\nTo enable this feature, you will need a GitHub app which has access to your repository and a corresponding private key. If you do not already have those, instructions can be found below.\n\n\nGitHub App Setup\n\nCreate a new GitHub App either on your personal account or on an organization. The app will need the following permissions:\n\n- **Issues** - Read & Write\n- **Metadata** - Read-only\n\nOnce created, install the GitHub App to your account. The app will need to be given access to the repositories you want to use the canary feature with.\n\nIn addition to the **App ID** that is assigned automatically, you will also need to generate a **Private Key** for the app. This can be done by clicking the **Generate a private key** button on the app page.\n\n> [!NOTE]\n> The private keys provided by GitHub are in PKCS#1 format, but only PKCS#8 is supported. You can convert the key file with the following command.\n\n```bash\nopenssl pkcs8 -topk8 -inform PEM -outform PEM -nocrypt -in private-key.pem -out private-key-pkcs8.key\n```\n\nEach server that intends to use the canary feature will need to have the private key installed somewhere the server process can access it.\n\n\n### Configure Canary\n\n```json\n\"spooder\": {\n\t\"canary\": {\n\t\t\"enabled\": true,\n\t\t\"account\": \"\",\n\t\t\"repository\": \"\",\n\t\t\"labels\": [\"some-label\"]\n\t}\n}\n```\n\nReplace `` with the account name you have installed the GitHub App to, and `` with the repository name you want to use for issues.\n\nThe repository name must in the full-name format `owner/repo` (e.g. `facebook/react`).\n\nThe `labels` property can be used to provide a list of labels to automatically add to the issue. This property is optional and can be omitted.\n\n### Setup Environment Variables\n\nThe following two environment variables must be defined on the server.\n\n```\nSPOODER_CANARY_APP_ID=1234\nSPOODER_CANARY_KEY=/home/bond/.ssh/id_007_pcks8.key\n```\n\n`SPOODER_CANARY_APP_ID` is the **App ID** as shown on the GitHub App page.\n\n`SPOODER_CANARY_KEY` is the path to the private key file in PKCS#8 format.\n\n> [!NOTE]\n> Since `spooder` uses the Bun runtime, you can use the `.env.local` file in the project root directory to set these environment variables per-project.\n\n### Using Canary\n\nOnce configured, `spooder` will automatically raise an issue when the server exits with a non-zero exit code. \n\nIn addition, you can manually raise issues using the `spooder` API by calling `caution()` or `panic()`. More information about these functions can be found in the `API` section.\n\nIf `canary` has not been configured correctly, `spooder` will only print warnings to the console when it attempts to raise an issue.\n\n> [!WARNING]\n> Consider testing the canary feature with the `caution()` function before relying on it for critical issues.\n\n\n## CLI > Canary > Crash\n\nIt is recommended that you harden your server code against unexpected exceptions and use `panic()` and `caution()` to raise issues with selected diagnostic information.\n\nIn the event that the server does encounter an unexpected exception which causes it to exit with a non-zero exit code, `spooder` will provide some diagnostic information in the canary report.\n\nSince this issue has been caught externally, `spooder` has no context of the exception which was raised. Instead, the canary report will contain the output from both `stdout` and `stderr`.\n\n```json\n{\n\t\"proc_exit_code\": 1,\n\t\"console_output\": [\n\t\t\"[2.48ms] \\\".env.local\\\"\",\n\t\t\"Test output\",\n\t\t\"Test output\",\n\t\t\"4 | console.warn('Test output');\",\n\t\t\"5 | \",\n\t\t\"6 | // Create custom error class.\",\n\t\t\"7 | class TestError extends Error {\",\n\t\t\"8 | \tconstructor(message: string) {\",\n\t\t\"9 | \t\tsuper(message);\",\n\t\t\" ^\",\n\t\t\"TestError: Home is [IPv4 address]\",\n\t\t\" at new TestError (/mnt/i/spooder/test.ts:9:2)\",\n\t\t\" at /mnt/i/spooder/test.ts:13:6\",\n\t\t\"\"\n\t]\n}\n```\n\nThe `proc_exit_code` property contains the exit code that the server exited with.\n\nThe `console_output` will contain the last `64` lines of output from `stdout` and `stderr` combined. This can be configured by setting the `spooder.canary.crash_console_history` property to a length of your choice.\n\n```json\n{\n\t\"spooder\": {\n\t\t\"canary\": {\n\t\t\t\"crash_console_history\": 128\n\t\t}\n\t}\n}\n```\n\nThis information is subject to sanitization, as described in the `CLI > Canary > Sanitization` section, however you should be aware that stack traces may contain sensitive information.\n\nSetting `spooder.canary.crash_console_history` to `0` will omit the `console_output` property from the report entirely, which may make it harder to diagnose the problem but will ensure that no sensitive information is leaked.\n\n\n## CLI > Canary > Sanitization\n\nAll reports sent via the canary feature are sanitized to prevent sensitive information from being leaked. This includes:\n\n- Environment variables from `.env.local`\n- IPv4 / IPv6 addresses.\n- E-mail addresses.\n\n```bash\n# .env.local\nDB_PASSWORD=secret\n```\n\n```ts\nawait panic({\n\ta: 'foo',\n\tb: process.env.DB_PASSWORD,\n\tc: 'Hello person@place.net',\n\td: 'Client: 192.168.1.1'\n});\n```\n\n```json\n[\n\t{\n\t\t\"a\": \"foo\",\n\t\t\"b\": \"[redacted]\",\n\t\t\"c\": \"Hello [e-mail address]\",\n\t\t\"d\": \"Client: [IPv4 address]\"\n\t}\n]\n```\n\nThe sanitization behavior can be disabled by setting `spooder.canary.sanitize` to `false` in the configuration. This is not recommended as it may leak sensitive information.\n\n```json\n{\n\t\"spooder\": {\n\t\t\"canary\": {\n\t\t\t\"sanitize\": false\n\t\t}\n\t}\n}\n```\n\n> [!WARNING]\n> While this sanitization adds a layer of protection against information leaking, it does not catch everything. You should pay special attention to messages and objects provided to the canary to not unintentionally leak sensitive information.\n\n\n## CLI > Canary > System Information\n\nIn addition to the information provided by the developer, `spooder` also includes some system information in the canary reports.\n\n```json\n{\n\t\"loadavg\": [\n\t\t0,\n\t\t0,\n\t\t0\n\t],\n\t\"memory\": {\n\t\t\"free\": 7620907008,\n\t\t\"total\": 8261840896\n\t},\n\t\"platform\": \"linux\",\n\t\"uptime\": 7123,\n\t\"versions\": {\n\t\t\"node\": \"18.15.0\",\n\t\t\"bun\": \"0.6.5\",\n\t\t\"webkit\": \"60d11703a533fd694cd1d6ddda04813eecb5d69f\",\n\t\t\"boringssl\": \"b275c5ce1c88bc06f5a967026d3c0ce1df2be815\",\n\t\t\"libarchive\": \"dc321febde83dd0f31158e1be61a7aedda65e7a2\",\n\t\t\"mimalloc\": \"3c7079967a269027e438a2aac83197076d9fe09d\",\n\t\t\"picohttpparser\": \"066d2b1e9ab820703db0837a7255d92d30f0c9f5\",\n\t\t\"uwebsockets\": \"70b1b9fc1341e8b791b42c5447f90505c2abe156\",\n\t\t\"zig\": \"0.11.0-dev.2571+31738de28\",\n\t\t\"zlib\": \"885674026394870b7e7a05b7bf1ec5eb7bd8a9c0\",\n\t\t\"tinycc\": \"2d3ad9e0d32194ad7fd867b66ebe218dcc8cb5cd\",\n\t\t\"lolhtml\": \"2eed349dcdfa4ff5c19fe7c6e501cfd687601033\",\n\t\t\"ares\": \"0e7a5dee0fbb04080750cf6eabbe89d8bae87faa\",\n\t\t\"usockets\": \"fafc241e8664243fc0c51d69684d5d02b9805134\",\n\t\t\"v8\": \"10.8.168.20-node.8\",\n\t\t\"uv\": \"1.44.2\",\n\t\t\"napi\": \"8\",\n\t\t\"modules\": \"108\"\n\t},\n\t\"bun\": {\n\t\t\"version\": \"0.6.5\",\n\t\t\"rev\": \"f02561530fda1ee9396f51c8bc99b38716e38296\",\n\t\t\"memory_usage\": {\n\t\t\t\"rss\": 99672064,\n\t\t\t\"heapTotal\": 3039232,\n\t\t\t\"heapUsed\": 2332783,\n\t\t\t\"external\": 0,\n\t\t\t\"arrayBuffers\": 0\n\t\t},\n\t\t\"cpu_usage\": {\n\t\t\t\"user\": 50469,\n\t\t\t\"system\": 0\n\t\t}\n\t}\n}\n```\n\n\n## CLI > Logging\n\n> [!NOTE]\n> This feature is not enabled by default.\n\n`spooder` can capture `stdout` and `stderr` output from each instance and write it to log files on disk. Each instance gets its own log file named `{instance_id}.log` inside the configured directory.\n\n```json\n{\n\t\"spooder\": {\n\t\t\"logging\": {\n\t\t\t\"enabled\": true,\n\t\t\t\"directory\": \"logs\",\n\t\t\t\"max_size\": 10485760,\n\t\t\t\"max_files\": 3\n\t\t}\n\t}\n}\n```\n\n| Property | Default | Description |\n| --- | --- | --- |\n| `enabled` | `false` | Enable file logging |\n| `directory` | `\"logs\"` | Directory for log files (relative to project root) |\n| `max_size` | `10485760` (10MB) | Maximum size in bytes before rotating |\n| `max_files` | `3` | Number of rotated files to keep |\n\nWhen a log file exceeds `max_size`, it is rotated: `instance.log` becomes `instance.1.log`, `instance.1.log` becomes `instance.2.log`, and so on. Files beyond `max_files` are deleted.\n\nThe log directory is created automatically on startup if it does not exist. Output is still printed to the console as normal — file logging is additive.\n\n> [!TIP]\n> You should add the log directory to your `.gitignore` to prevent log files from being committed.\n\n> [!NOTE]\n> When logging is enabled, instance output is piped through the CLI process regardless of the `canary.crash_console_history` setting. Both features can operate independently or together.\n\n# API\n\n\n## API > Cheatsheet\n\n```ts\n// logging\nlog(message: string, ...params: any[]);\nlog_error(message: string, ...params: any[]);\nlog_create_logger(prefix: string, color: ColorInput);\nlog_list(input: any[], delimiter = ', ');\n\n// http\nhttp_serve(port: number, hostname?: string): Server;\nserver.port: number;\nserver.stop(immediate: boolean): Promise;\n\n// cookies\ncookies_get(req: Request): Bun.CookieMap\n\n// routing\nserver.route(path: string, handler: RequestHandler, method?: HTTP_METHODS);\nserver.json(path: string, handler: JSONRequestHandler, method?: HTTP_METHODS);\nserver.throttle(delta: number, handler: JSONRequestHandler|RequestHandler);\nserver.unroute(path: string);\n\n// fallback handlers\nserver.handle(status_code: number, handler: RequestHandler);\nserver.default(handler: DefaultHandler);\nserver.error(handler: ErrorHandler);\nserver.on_slow_request(callback: SlowRequestCallback, threshold?: number);\nserver.allow_slow_request(req: Request);\n\n// http generics\nhttp_apply_range(file: BunFile, request: Request): HandlerReturnType;\n\n// directory serving\nserver.dir(path: string, dir: string, options?: DirOptions | DirHandler, method?: HTTP_METHODS);\n\n// server-sent events\nserver.sse(path: string, handler: ServerSentEventHandler);\n\n// webhooks\nserver.webhook(secret: string, path: string, handler: WebhookHandler, branches?: string | string[]);\n\n// websockets\nserver.websocket(path: string, handlers: WebsocketHandlers);\n\n// bootstrap\nserver.bootstrap(options: BootstrapOptions): Promise;\n\n// error handling\nErrorWithMetadata(message: string, metadata: object);\ncaution(err_message_or_obj: string | object, ...err: object[]): Promise;\npanic(err_message_or_obj: string | object, ...err: object[]): Promise;\nsafe(fn: Callable): Promise;\n\n// worker (main thread)\nworker_pool(options: WorkerPoolOptions): Promise;\npool.id: string;\npool.send: (peer: string, id: string, data?: WorkerMessageData) => void;\npool.broadcast: (id: string, data?: WorkerMessageData) => void;\npool.on: (event: string, callback: (message: WorkerMessage) => Promise | void) => void;\npool.once: (event: string, callback: (message: WorkerMessage) => Promise | void) => void;\npool.off: (event: string) => void;\n\ntype WorkerPoolOptions = {\n\tid?: string;\n\tworker: string | string[];\n\tsize?: number;\n\tauto_restart?: boolean | AutoRestartConfig;\n\tonWorkerStart?: (pool: WorkerPool, worker_id: string) => void;\n\tonWorkerStop?: (pool: WorkerPool, worker_id: string, exit_code: number) => void;\n};\n\ntype AutoRestartConfig = {\n\tbackoff_max?: number; // default: 5 * 60 * 1000 (5 min)\n\tbackoff_grace?: number; // default: 30000 (30 seconds)\n\tmax_attempts?: number; // default: 5, -1 for unlimited\n};\n\n// worker (worker thread)\nworker_connect(peer_id?: string): WorkerPool;\n\n// templates\nReplacements = Record | object | object[]> | ReplacerFn | AsyncReplaceFn;\nparse_template(template: string, replacements: Replacements, drop_missing?: boolean): Promise;\n\n// cache busting\ncache_bust(string|string[]: path, format: string): string|string[]\ncache_bust_set_hash_length(length: number): void;\ncache_bust_set_format(format: string): void;\ncache_bust_get_hash_table(): Record;\n\n// git\ngit_get_hashes(length: number): Promise>;\ngit_get_hashes_sync(length: number): Record;\n\n// database utilities\ndb_set_cast(set: string | null): Set;\ndb_set_serialize(set: Iterable | null): string;\ndb_exists(db: SQL, table_name: string, value: string|number, column_name = 'id'): Promise;\n\n// database schema\ntype SchemaOptions = {\n\tschema_table?: string;\n\trecursive?: boolean;\n};\n\ndb_get_schema_revision(db: SQL): Promise;\ndb_schema(db: SQL, schema_path: string, options?: SchemaOptions): Promise;\n\n// caching\ncache_http(options?: CacheOptions);\ncache.file(file_path: string): RequestHandler;\ncache.request(req: Request, cache_key: string, content_generator: () => string | Promise): Promise;\n\n// utilities\nfilesize(bytes: number): string;\nBiMap: class BiMap;\n\n// ipc\nipc_register(op: number, callback: IPC_Callback);\nipc_send(target: string, op: number, data?: object);\n\n// constants\nHTTP_STATUS_TEXT: Record;\nHTTP_STATUS_CODE: { OK_200: 200, NotFound_404: 404, ... };\nEXIT_CODE: Record;\nEXIT_CODE_NAMES: Record;\nIPC_TARGET: Record;\nIPC_OP: Record;\n```\n\n\n## API > Logging\n\n### 🔧 `log(message: string, ...params: any[])`\nPrint a message to the console using the default logger. Wrapping text segments in curly braces will highlight those segments with colour.\n\n```ts\nlog('Hello, {world}!');\n// > [info] Hello, world!\n```\n\nTagged template literals are also supported and automatically highlights values without the brace syntax.\n\n```ts\nconst user = 'Fred';\nlog`Hello ${user}!`;\n```\n\nFormatting parameters are supported using standard console logging formatters.\n\n```ts\nlog('My object: %o', { foo: 'bar' });\n// > [info] My object: { foo: 'bar' }\n```\n\n| Specifier | Description |\n|-----------|-------------|\n| `%s` | String |\n| `%d` | Integer |\n| `%i` | Integer (same as %d) |\n| `%f` | Floating point |\n| `%o` | Object (pretty-printed) |\n| `%O` | Object (expanded/detailed) |\n| `%j` | JSON string |\n\n### 🔧 `log_error(message: string, ...params: any[])`\nPrint an error message to the console. Wrapping text segments in curly braces will highlight those segments. This works the same as `log()` except it's red, so you know it's bad.\n\n```ts\nlog_error('Something went {really} wrong');\n// > [error] Something went really wrong\n```\n\n### 🔧 `log_create_logger(prefix: string, color: ColorInput)`\nCreate a `log()` function with a custom prefix and highlight colour.\n\n```ts\nconst db_log = log_create_logger('db', 'pink');\ndb_log('Creating table {users}...');\n```\n\n> [!INFO]\n> For information about `ColorInput`, see the [Bun Color API](https://bun.sh/docs/api/color).\n\n\n### 🔧 `log_list(input: any[], delimiter = ', ')`\nUtility function that joins an array of items together with each element wrapped in highlighting syntax for logging.\n\n```ts\nconst fruit = ['apple', 'orange', 'peach'];\nlog(`Fruit must be one of ${fruit.map(e => `{${e}}`).join(', ')}`);\nlog(`Fruit must be one of ${log_list(fruit)}`);\n```\n\n\n## API > IPC\n\n`spooder` provides a way to send/receive messages between different instances via IPC. See [CLI > Instancing](#cli-instancing) for documentation on instances.\n\n```ts\n// listen for a message\nipc_register(0x1, msg => {\n\t// msg.peer, msg.op, msg.data\n\tconsole.log(msg.data.foo); // 42\n});\n\n// send a message to dev02\nipc_send('dev02', 0x1, { foo: 42 });\n\n// send a message to all other instances\nipc_send(IPC_TARGET.BROADCAST, 0x1, { foo: 42 });\n```\n\nThis can also be used to communicate with the host process for certain functionality, such as [auto-restarting](#cli-auto-restart).\n\n#### OpCodes\n\nWhen sending/receiving IPC messages, the message will include an opcode. When communicating with the host process, that will be one of the following:\n\n```ts\nIPC_OP.CMSG_TRIGGER_UPDATE = -1;\nIPC_OP.SMSG_UPDATE_READY = -2;\nIPC_OP.CMSG_REGISTER_LISTENER = -3; // used internally by ipc_register\n```\n\nWhen sending/receiving your own messages, you can define and use your own ID schema. To prevent conflict with internal opcodes, always use positive values; `spooder` internal opcodes will always be negative.\n\n### `ipc_register(op: number, callback: IPC_Callback)`\n\nRegister a listener for IPC events. The callback will receive an object with this structure:\n\n```ts\ntype IPC_Message = {\n\top: number; // opcode received\n\tpeer: string; // sender\n\tdata?: object // payload data (optional)\n};\n```\n\n### `ipc_send(peer: string, op: number, data?: object)`\n\nSend an IPC event. The target can either be the ID of another instance (such as the `peer` ID from an `IPC_Message`) or one of the following constants.\n\n```ts\nIPC_TARGET.SPOODER; // communicate with the host\nIPC_TARGET.BROADCAST; // broadcast to all other instances\n```\n\n\n## API > HTTP\n\n### `http_serve(port: number, hostname?: string): Server`\nBootstrap a server on the specified port (and optional hostname). Pass `0` for the port to assign a random available port, which can then be retrieved via `server.port`.\n\n```ts\nimport { serve } from 'spooder';\n\nconst server = http_serve(8080); // port only\nconst server = http_serve(3000, '0.0.0.0'); // optional hostname\nconst server = http_serve(0); // random port, retrieve via server.port\n```\n\nBy default, the server responds with:\n\n```http\nHTTP/1.1 404 Not Found\nContent-Length: 9\nContent-Type: text/plain;charset=utf-8\n\nNot Found\n```\n\n### 🔧 `server.stop(immediate: boolean)`\n\nStop the server process immediately, terminating all in-flight requests.\n\n```ts\nserver.stop(true);\n```\n\nStop the server process gracefully, waiting for all in-flight requests to complete.\n\n```ts\nserver.stop(false);\n```\n\n`server.stop()` returns a promise, which if awaited, resolves when all pending connections have been completed.\n```ts\nawait server.stop(false);\n// do something now all connections are done\n```\n\n### 📖 `server.port`\n\nReturns the port the server is listening on. Useful when `0` is passed to `http_serve()` for a random port assignment.\n\n```ts\nconst server = http_serve(0);\nconsole.log(`Server listening on port ${server.port}`);\n```\n\n### Routing\n\n### 🔧 `server.route(path: string, handler: RequestHandler)`\n\nRegister a handler for a specific path.\n\n```ts\nserver.route('/test/route', (req, url) => {\n\treturn new Response('Hello, world!', { status: 200 });\n});\n```\n\n### 🔧 `server.unroute(path: string)`\n\nUnregister a specific route.\n\n```ts\nserver.route('/test/route', () => {});\nserver.unroute('/test/route');\n```\n\n### 🔧 `server.throttle(delta: number, handler: JSONRequestHandler|RequestHandler)`\n\nThrottles requests going through the provided handler so that they take a **minimum** of `delta` milliseconds. Useful for preventing brute-force of sensitive endpoints.\n\n> [!IMPORTANT]\n> This is a rudimentary countermeasure for brute-force attacks, **not** a defence against timing-attacks. Always use constant-time/timing-safe comparison functions in sensitive endpoints.\n\n```ts\nserver.json('/api/login', server.throttle(1000, (req, url, json) => {\n\t// this endpoint will always take at least 1000ms to execute\n}));\n\n// works with regular routes\nserver.route('/reset-password', server.throttle(1000, (req, url) => {\n\t// this route will also take at least 1000ms to execute\n}));\n```\n\n### 🔧 `server.json(path: string, handler: JSONRequestHandler, method?: HTTP_METHODS)`\n\nRegister a JSON endpoint with automatic content validation. This method automatically validates that the request has the correct `Content-Type: application/json` header and that the request body contains a valid JSON object.\n\n```ts\nserver.json('/api/users', (req, url, json) => {\n\t// json is automatically parsed and validated as a plain object\n\tconst name = json.name;\n\tconst email = json.email;\n\t\n\t// Process the JSON data\n\treturn { success: true, id: 123 };\n});\n```\n\nBy default, JSON routes are registered as `POST` endpoints, but this can be customized:\n\n```ts\nserver.json('/api/data', (req, url, json) => {\n\treturn { received: json };\n}, 'PUT');\n```\n\nThe handler will automatically return `400 Bad Request` if:\n- The `Content-Type` header is not `application/json`\n- The request body is not valid JSON\n- The JSON is not a plain object (e.g., it's an array, null, or primitive value)\n\n### HTTP Methods\n\nBy default, `spooder` will register routes defined with `server.route()` and `server.dir()` as `GET` routes, while `server.json()` routes default to `POST`. Requests to these routes with other methods will return `405 Method Not Allowed`.\n\n> [!NOTE]\n> Routes that accept `GET` also accept `HEAD`. The `GET` handler runs and Bun removes the body from the response, keeping the status and headers. Handlers that must tell the two apart can read `req.method`.\n\nThis can be controlled by providing the `method` parameter with a string or array defining one or more of the following methods.\n\n```\nGET | HEAD | POST | PUT | DELETE | CONNECT | OPTIONS | TRACE | PATCH\n```\n\n```ts\nserver.route('/test/route', (req, url) => {\n\tif (req.method === 'GET')\n\t\t// Handle GET request.\n\telse if (req.method === 'POST')\n\t\t// Handle POST request.\n}, ['GET', 'POST']);\n```\n\n> [!NOTE]\n> Routes defined with .sse() or .webhook() are always registered as 'GET' and 'POST' respectively and cannot be configured.\n\n### Redirection Routes\n\n`spooder` does not provide a built-in redirection handler since it's trivial to implement one using [`Response.redirect`](https://developer.mozilla.org/en-US/docs/Web/API/Response/redirect_static), part of the standard Web API.\n\n```ts\nserver.route('/redirect', () => Response.redirect('/redirected', HTTP_STATUS_CODE.MovedPermanently_301));\n```\n\n### Status Code Text\n\n`spooder` exposes `HTTP_STATUS_TEXT` to conveniently access status code text, and `HTTP_STATUS_CODE` for named status code constants.\n\n```ts\nimport { HTTP_STATUS_TEXT, HTTP_STATUS_CODE } from 'spooder';\n\nserver.default((req, status_code) => {\n\t// status_code: 404\n\t// Body: Not Found\n\treturn new Response(HTTP_STATUS_TEXT[status_code], { status: status_code });\n});\n\n// Using named constants for better readability\nserver.route('/api/users', (req, url) => {\n\tif (!isValidUser(req))\n\t\treturn HTTP_STATUS_CODE.Unauthorized_401;\n\t\n\t// Process user request\n\treturn HTTP_STATUS_CODE.OK_200;\n});\n```\n\n### RequestHandler\n\n`RequestHandler` is a function that accepts a [`Request`](https://developer.mozilla.org/en-US/docs/Web/API/Request) object and a [`URL`](https://developer.mozilla.org/en-US/docs/Web/API/URL) object and returns a `HandlerReturnType`.\n\n`HandlerReturnType` must be one of the following.\n\n| Type | Description |\n| --- | --- |\n| `Response` | https://developer.mozilla.org/en-US/docs/Web/API/Response |\n| `Blob` | https://developer.mozilla.org/en-US/docs/Web/API/Blob |\n| `BunFile` | https://bun.sh/docs/api/file-io |\n| `object` | Will be serialized to JSON. |\n| `string` | Will be sent as `text/html``. |\n| `number` | Sets status code and sends status message as plain text. |\n\n> [!NOTE]\n> For custom JSON serialization on an object/class, implement the [`toJSON()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify) method.\n\n`HandleReturnType` can also be a promise resolving to any of the above types, which will be awaited before sending the response.\n\n> [!NOTE]\n> Returning `Bun.file()` directly is the most efficient way to serve static files as it uses system calls to stream the file directly to the client without loading into user-space.\n\n### Query Parameters\n\nQuery parameters can be accessed from the `searchParams` property on the `URL` object.\n\n```ts\nserver.route('/test', (req, url) => {\n\treturn new Response(url.searchParams.get('foo'), { status: 200 });\n});\n```\n\n```http\nGET /test?foo=bar HTTP/1.1\n\nHTTP/1.1 200 OK\nContent-Length: 3\n\nbar\n```\n\nNamed parameters can be used in paths by prefixing a path segment with a colon.\n\n> [!IMPORTANT]\n> Named parameters will overwrite existing query parameters with the same name.\n\n```ts\nserver.route('/test/:param', (req, url) => {\n\treturn new Response(url.searchParams.get('param'), { status: 200 });\n});\n```\n\n### Wildcards\n\nWildcards can be used to match any path that starts with a given path.\n\n> [!NOTE]\n> If you intend to use this for directory serving, you may be better suited looking at the `server.dir()` function.\n\n```ts\nserver.route('/test/*', (req, url) => {\n\treturn new Response('Hello, world!', { status: HTTP_STATUS_CODE.OK_200 });\n});\n```\n\n> [!IMPORTANT]\n> Routes are [FIFO](https://en.wikipedia.org/wiki/FIFO_(computing_and_electronics)) and wildcards are greedy. Wildcards should be registered last to ensure they do not consume more specific routes.\n\n```ts\nserver.route('/*', () => HTTP_STATUS_CODE.MovedPermanently_301);\nserver.route('/test', () => HTTP_STATUS_CODE.OK_200);\n\n// Accessing /test returns 301 here, because /* matches /test first.\n```\n\n### Fallback Handlers\n\n### 🔧 `server.handle(status_code: number, handler: RequestHandler)`\nRegister a custom handler for a specific status code.\n```ts\nserver.handle(HTTP_STATUS_CODE.InternalServerError_500, (req) => {\n\treturn new Response('Custom Internal Server Error Message', { status: HTTP_STATUS_CODE.InternalServerError_500 });\n});\n```\n\n### 🔧 `server.default(handler: DefaultHandler)`\nRegister a handler for all unhandled response codes.\n> [!NOTE]\n> If you return a `Response` object from here, you must explicitly set the status code.\n```ts\nserver.default((req, status_code) => {\n\treturn new Response(`Custom handler for: ${status_code}`, { status: status_code });\n});\n```\n\n### 🔧 `server.error(handler: ErrorHandler)`\nRegister a handler for uncaught errors.\n\n> [!NOTE]\n> Unlike other handlers, this should only return `Response` or `Promise`.\n```ts\nserver.error((err, req, url) => {\n\treturn new Response('Custom Internal Server Error Message', { status: HTTP_STATUS_CODE.InternalServerError_500 });\n});\n```\n\n> [!IMPORTANT]\n> It is highly recommended to use `caution()` or some form of reporting to notify you when this handler is called, as it means an error went entirely uncaught.\n\n```ts\nserver.error((err, req, url) => {\n\t// Notify yourself of the error.\n\tcaution({ err, url });\n\n\t// Return a response to the client.\n\treturn new Response('Custom Internal Server Error Message', { status: HTTP_STATUS_CODE.InternalServerError_500 });\n});\n```\n\n### Slow Requests\n\n### 🔧 `server.on_slow_request(callback: SlowRequestCallback, threshold: number)`\n\n`server.on_slow_request` can be used to register a callback for requests that take an undesirable amount of time to process.\n\nBy default requests that take longer than `1000ms` to process will trigger the callback, but this can be adjusted by providing a custom threshold.\n\n> [!IMPORTANT]\n> If your canary reports to a public repository, be cautious about directly including the `req` object in the callback. This can lead to sensitive information being leaked.\n\n```ts\nserver.on_slow_request(async (req, time, url) => {\n\t// avoid `time` in the title to avoid canary spam\n\t// see caution() API for information\n\tawait caution('Slow request warning', { req, time });\n}, 500);\n```\n\n> [!NOTE]\n> The callback is not awaited internally, so you can use `async/await` freely without blocking the server/request.\n\n### 🔧 `server.allow_slow_request(req: Request)`\n\nIn some scenarios, mitigation throttling or heavy workloads may cause slow requests intentionally. To prevent these triggering a caution, requests can be marked as slow.\n\n```ts\nserver.on_slow_request(async (req, time, url) => {\n\tawait caution('Slow request warning', { req, time });\n}, 500);\n\nserver.route('/test', async (req) => {\n\t// this request is marked as slow, therefore won't\n\t// trigger on_slow_request despite taking 5000ms+\n\tserver.allow_slow_request(req);\n\tawait new Promise(res => setTimeout(res, 5000));\n});\n```\n\n> [!NOTE]\n> This will have no effect if a handler hasn't been registered with `on_slow_request`.\n\n\n## API > HTTP > Directory Serving\n\n### 🔧 `server.dir(path: string, dir: string, options?: DirOptions | DirHandler)`\nServe files from a directory.\n\n```ts\nserver.dir('/content', './public/content');\n```\n\n> [!IMPORTANT]\n> `server.dir` registers a wildcard route. Routes are [FIFO](https://en.wikipedia.org/wiki/FIFO_(computing_and_electronics)) and wildcards are greedy. Directories should be registered last to ensure they do not consume more specific routes.\n\n```ts\nserver.dir('/', '/files');\nserver.route('/test', () => 200);\n\n// Route / is equal to /* with server.dir()\n// Accessing /test returns 404 here because /files/test does not exist.\n```\n\n#### Directory Options\n\nYou can configure directory behavior using the `DirOptions` interface:\n\n```ts\ninterface DirOptions {\n\tignore_hidden?: boolean; // default: true\n\tindex_directories?: boolean; // default: false \n\tsupport_ranges?: boolean; // default: true\n}\n```\n\n**Options-based configuration:**\n```ts\n// Enable directory browsing with HTML listings\nserver.dir('/files', './public', { index_directories: true });\n\n// Serve hidden files and disable range requests\nserver.dir('/files', './public', { \n\tignore_hidden: false, \n\tsupport_ranges: false \n});\n\n// Full configuration\nserver.dir('/files', './public', { \n\tignore_hidden: true,\n\tindex_directories: true,\n\tsupport_ranges: true \n});\n```\n\nWhen `index_directories` is enabled, accessing a directory will return a styled HTML page listing the directory contents with file and folder icons.\n\n#### Custom Directory Handlers\n\nFor complete control, provide a custom handler function:\n\n```ts\nserver.dir('/static', '/static', (file_path, file, stat, request, url) => {\n\t// ignore hidden files by default, return 404 to prevent file sniffing\n\tif (path.basename(file_path).startsWith('.'))\n\t\treturn HTTP_STATUS_CODE.NotFound_404;\n\n\tif (stat.isDirectory())\n\t\treturn HTTP_STATUS_CODE.Unauthorized_401;\n\n\treturn http_apply_range(file, request);\n});\n```\n\n| Parameter | Type | Reference |\n| --- | --- | --- |\n| `file_path` | `string` | The path to the file on disk. |\n| `file` | `BunFile` | https://bun.sh/docs/api/file-io |\n| `stat` | `fs.Stats` | https://nodejs.org/api/fs.html#class-fsstats |\n| `request` | `Request` | https://developer.mozilla.org/en-US/docs/Web/API/Request |\n| `url` | `URL` | https://developer.mozilla.org/en-US/docs/Web/API/URL |\n\nAsynchronous directory handlers are supported and will be awaited.\n\n```ts\nserver.dir('/static', '/static', async (file_path, file) => {\n\tlet file_contents = await file.text();\n\t// do something with file_contents\n\treturn file_contents;\n});\n```\n\n> [!NOTE]\n> The directory handler function is only called for files that exist on disk - including directories.\n\n> [!NOTE]\n> Uncaught `ENOENT` errors thrown from the directory handler will return a `404` response, other errors will return a `500` response.\n\n### 🔧 `http_apply_range(file: BunFile, request: Request): HandlerReturnType`\n\n`http_apply_range` parses the `Range` header for a request and slices the file accordingly. This is used internally by `server.dir()` and exposed for convenience.\n\n```ts\nserver.route('/test', (req, url) => {\n\tconst file = Bun.file('./test.txt');\n\treturn http_apply_range(file, req);\n});\n```\n\n```http\nGET /test HTTP/1.1\nRange: bytes=0-5\n\nHTTP/1.1 206 Partial Content\nContent-Length: 6\nContent-Range: bytes 0-5/6\nContent-Type: text/plain;charset=utf-8\n\nHello,\n```\n\n\n## API > HTTP > Server-Sent Events (SSE)\n\n### 🔧 `server.sse(path: string, handler: ServerSentEventHandler)`\n\nSetup a [server-sent event](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events) stream.\n\n```ts\nserver.sse('/sse', (req, url, client) => {\n\tclient.message('Hello, client!'); // Unnamed event.\n\tclient.event('named_event', 'Hello, client!'); // Named event.\n\n\tclient.message(JSON.stringify({ foo: 'bar' })); // JSON message.\n});\n```\n\n`client.closed` is a promise that resolves when the client closes the connection.\n\n```ts\nconst clients = new Set();\n\nserver.sse('/sse', (req, url, client) => {\n\tclients.add(client);\n\tclient.closed.then(() => clients.delete(client));\n});\n```\n\nConnections can be manually closed with `client.close()`. This will also trigger the `client.closed` promise to resolve.\n\n```ts\nserver.sse('/sse', (req, url, client) => {\n\tclient.message('Hello, client!');\n\n\tsetTimeout(() => {\n\t\tclient.message('Goodbye, client!');\n\t\tclient.close();\n\t}, 5000);\n});\n```\n\n\n## API > HTTP > Webhooks\n\n### 🔧 `server.webhook(secret: string, path: string, handler: WebhookHandler, branches?: string | string[])`\n\nSetup a webhook handler.\n\n```ts\nserver.webhook(process.env.WEBHOOK_SECRET, '/webhook', payload => {\n\t// React to the webhook.\n\treturn HTTP_STATUS_CODE.OK_200;\n});\n```\n\n#### Branch Filtering\n\nYou can optionally filter webhooks by branch name using the `branches` parameter:\n\n```ts\n// Only trigger for main branch\nserver.webhook(process.env.WEBHOOK_SECRET, '/webhook', payload => {\n\t// This will only fire for pushes to main branch\n\treturn HTTP_STATUS_CODE.OK_200;\n}, 'main');\n\n// Trigger for multiple branches\nserver.webhook(process.env.WEBHOOK_SECRET, '/webhook', payload => {\n\t// This will fire for pushes to main or staging branches\n\treturn HTTP_STATUS_CODE.OK_200;\n}, ['main', 'staging']);\n```\n\nWhen branch filtering is enabled, the webhook handler will only be called for pushes to the specified branches. The branch name is extracted from the payload's `ref` field (e.g., `refs/heads/main` becomes `main`).\n\nA webhook callback will only be called if the following critera is met by a request:\n- Request method is `POST` (returns `405` otherwise)\n- Header `X-Hub-Signature-256` is present (returns `400` otherwise)\n- Header `Content-Type` is `application/json` (returns `401` otherwise)\n- Request body is a valid JSON object (returns `500` otherwise)\n- HMAC signature of the request body matches the `X-Hub-Signature-256` header (returns `401` otherwise)\n- If branch filtering is enabled, the push must be to one of the specified branches (returns `200` but ignores otherwise)\n\n> [!NOTE]\n> Constant-time comparison is used to prevent timing attacks when comparing the HMAC signature.\n\n\n## API > HTTP > Websocket Server\n\n### 🔧 `server.websocket(path: string, handlers: WebSocketHandlers)`\n\nRegister a route which handles websocket connections.\n\n```ts\nserver.websocket('/path/to/websocket', {\n\t// all of these handlers are OPTIONAL\n\n\taccept: (req, url) => {\n\t\t// validates a request before it is upgraded\n\t\t// returns HTTP 401 if FALSE is returned\n\t\t// allows you to check headers/authentication\n\t\t// url parameter contains query parameters from route\n\n\t\t// if an OBJECT is returned, the object will\n\t\t// be accessible on the websocket as ws.data.*\n\n\t\treturn true;\n\t},\n\n\topen: (ws) => {\n\t\t// called when a websocket client connects\n\t},\n\n\tclose: (ws, code, reason) => {\n\t\t// called when a websocket client disconnects\n\t},\n\n\tmessage: (ws, message) => {\n\t\t// called when a websocket message is received\n\t\t// message is a string or buffer\n\t},\n\n\tmessage_json: (ws, data) => {\n\t\t// called when a websocket message is received\n\t\t// payload is parsed as JSON\n\n\t\t// if payload cannot be parsed, socket will be\n\t\t// closed with error 1003: Unsupported Data\n\n\t\t// messages are only internally parsed if this\n\t\t// handler is present\n\t},\n\n\tdrain: (ws) => {\n\t\t// called when a websocket with backpressure drains\n\t}\n});\n```\n\n> [!IMPORTANT]\n> While it is possible to register multiple routes for websockets, the only handler which is unique per route is `accept()`. The last handlers provided to any route (with the exception of `accept()`) will apply to ALL websocket routes. This is a limitation in Bun.\n\n\n## API > HTTP > Bootstrap\n\n`spooder` provides a building-block style API with the intention of giving you the blocks to construct a server your way, rather than being shoe-horned into one over-engineered mega-solution which you don't need.\n\nFor simpler projects, the scaffolding can often look the same, potentially something similar to below.\n\n```ts\nimport { http_serve, cache_http, parse_template, http_apply_range, git_get_hashes } from 'spooder';\nimport path from 'node:path';\n\nconst server = http_serve(80);\nconst cache = cache_http({\n\tttl: 5 * 60 * 60 * 1000, // 5 minutes\n\tmax_size: 5 * 1024 * 1024, // 5 MB\n\tuse_canary_reporting: true,\n\tuse_etags: true\n});\n\nconst base_file = await Bun.file('./html/base_template.html').text();\nconst git_hash_table = await git_get_hashes();\n\nasync function default_handler(status_code: number): Promise {\n\tconst error_text = HTTP_STATUS_CODE[status_code] as string;\n\tconst error_page = await Bun.file('./html/error.html').text();\n\n\tconst content = await parse_template(error_page, {\n\t\ttitle: error_text,\n\t\terror_code: status_code.toString(),\n\t\terror_text: error_text\n\t}, true);\n\n\treturn new Response(content, { status: status_code });\n}\n\nserver.error((err: Error) => {\n\tcaution(err?.message ?? err);\n\treturn default_handler(HTTP_STATUS_CODE.InternalServerError_500);\n});\n\nserver.default((req, status_code) => default_handler(status_code));\n\nserver.dir('/static', './static', async (file_path, file, stat, request) => {\n\t// ignore hidden files by default, return 404 to prevent file sniffing\n\tif (path.basename(file_path).startsWith('.'))\n\t\treturn HTTP_STATUS_CODE.NotFound_404;\n\t\n\tif (stat.isDirectory())\n\t\treturn HTTP_STATUS_CODE.Unauthorized_401;\n\n\t// serve css/js files directly\n\tconst ext = path.extname(file_path);\n\tif (ext === '.css' || ext === '.js') {\n\t\tconst content = await parse_template(await file.text(), {\n\t\t\tcache_bust: (file) => `${file}?v=${git_hash_table[file]}`\n\t\t}, true);\n\n\t\treturn new Response(content, {\n\t\t\theaders: {\n\t\t\t\t'Content-Type': file.type\n\t\t\t}\n\t\t});\n\t}\n\t\n\treturn http_apply_range(file, request);\n});\n\nfunction add_route(route: string, file: string, title: string) {\n\tserver.route(route, async (req) => {\n\t\treturn cache.request(req, route, async () => {\n\t\t\tconst file_content = await Bun.file(file).text();\n\t\t\tconst template = await parse_template(base_file, {\n\t\t\t\ttitle: title,\n\t\t\t\tcontent: file_content,\n\t\t\t\tasset: (file) => git_hash_table[file]\n\t\t\t}, true);\n\n\t\t\treturn template;\n\t\t});\n\t});\n}\n\nadd_route('/', './html/index.html', 'Homepage');\nadd_route('/about', './html/about.html', 'About Us');\nadd_route('/contact', './html/contact.html', 'Contact Us');\nadd_route('/privacy', './html/privacy.html', 'Privacy Policy');\nadd_route('/terms', './html/terms.html', 'Terms of Service');\n```\n\nFor a project where you are looking for fine control, this may be acceptable, but for bootstrapping simple servers this can be a lot of boilerplate. This is where `server.bootstrap` comes in.\n\n### 🔧 `server.bootstrap(options: BootstrapOptions): Promise`\n\nBootstrap a server using `spooder` utilities with a straight-forward options API, cutting out the boilerplate.\n\n```ts\nconst server = http_serve(80);\n\nserver.bootstrap({\n\tbase: Bun.file('./html/base_template.html'),\n\tdrop_missing_subs: false,\n\n\tcache: {\n\t\tttl: 5 * 60 * 60 * 1000, // 5 minutes\n\t\tmax_size: 5 * 1024 * 1024, // 5 MB\n\t\tuse_canary_reporting: true,\n\t\tuse_etags: true\n\t},\n\n\terror: {\n\t\tuse_canary_reporting: true,\n\t\terror_page: Bun.file('./html/error.html')\n\t},\n\t\n\tcache_bust: { // true or options\n\t\tformat: '$file#$hash', // default: $file?v=$hash\n\t\thash_length: 20, // default: 7\n\t\tprefix: 'bust' // default: cache_bust\n\t},\n\n\tstatic: {\n\t\tdirectory: './static',\n\t\troute: '/static',\n\t\tsub_ext: ['.css']\n\t},\n\n\tglobal_subs: {\n\t\t'project_name': 'Some Project'\n\t},\n\n\troutes: {\n\t\t'/': {\n\t\t\tcontent: Bun.file('./html/index.html'),\n\t\t\tsubs: { 'title': 'Homepage' }\n\t\t},\n\n\t\t'/about': {\n\t\t\tcontent: Bun.file('./html/about.html'),\n\t\t\tsubs: { 'title': 'About Us' }\n\t\t},\n\n\t\t'/contact': {\n\t\t\tcontent: Bun.file('./html/contact.html'),\n\t\t\tsubs: { 'title': 'Contact Us' }\n\t\t},\n\n\t\t'/privacy': {\n\t\t\tcontent: Bun.file('./html/privacy.html'),\n\t\t\tsubs: { 'title': 'Privacy Policy' }\n\t\t},\n\n\t\t'/terms': {\n\t\t\tcontent: Bun.file('./html/terms.html'),\n\t\t\tsubs: { 'title': 'Terms of Service' }\n\t\t}\n\t}\n});\n```\n\n#### Bootstrap Options\n\nThe `BootstrapOptions` object accepts the following properties:\n\n##### `base?: string | BunFile`\nOptional base template that wraps all route content. The base template should include `{{content}}` where the route content will be inserted.\n\n```ts\n// Base template: base.html\n\n{{title}}\n{{content}}\n\n\n// Usage\nserver.bootstrap({\n\tbase: Bun.file('./templates/base.html'),\n\troutes: {\n\t\t'/': {\n\t\t\tcontent: '
Welcome
',\n\t\t\tsubs: { title: 'Home' }\n\t\t}\n\t}\n});\n```\n\n##### `drop_missing_subs: boolean`\n\n**Optional**. Defaults to true. If explicitly disabled, templating parsing will not drop unknown substitutions.\n\n> ![NOTE]\n> If you are using a client-side framework that uses the double-brace syntax ``{{foo}}`` such as Vue, you should set this to `false` to ensure compatibility.\n\n##### `routes: Record`\n**Required.** Defines the routes and their content. Each route can have:\n- `content`: The page content (string or BunFile)\n- `subs?`: Template substitutions specific to this route\n\n```ts\nroutes: {\n\t'/about': {\n\t\tcontent: Bun.file('./pages/about.html'),\n\t\tsubs: { \n\t\t\ttitle: 'About Us',\n\t\t\tdescription: 'Learn more about our company'\n\t\t}\n\t}\n}\n```\n\n##### `cache?: CacheOptions | ReturnType`\nOptional HTTP caching configuration. Can be:\n- A `CacheOptions` object (creates new cache instance)\n- An existing cache instance from `cache_http()`\n- Omitted to disable caching\n\n```ts\ncache: {\n\tttl: 5 * 60 * 1000, // 5 minutes\n\tmax_size: 10 * 1024 * 1024, // 10 MB\n\tuse_etags: true,\n\tuse_canary_reporting: true\n}\n```\n\n##### `cache_bust?: CacheBustOptions | boolean`\nEnables the use of the [`cache_bust()`](#api-cache-busting) API inside templates using the ``{{cache_bust=file}}`` directive.\n\n```html\n\n\n\n```\n\nSince this uses the [`cache_bust()`](#api-cache-busting) API internally, it is effected by the `cache_bust_set_hash_length` and `cache_bust_set_format` global functions.\n\nSetting `cache_bust` to `true` assumes the normal defaults, however this can be customized by providing an options object.\n\n```ts\ncache_bust: { // true or options\n\tformat: '$file#$hash', // default: $file?v=$hash\n\thash_length: 20, // default: 7\n\tprefix: 'bust' // default: cache_bust\n},\n```\n\n> ![IMPORTANT]\n> `format` and `hash_length` internally call `cache_bust_set_format` and `cache_bust_set_hash_length` respectively, so these values will effect `cache_bust()` globally.\n\n##### `error?: object`\nOptional error page configuration:\n- `error_page`: Template for error pages (string or BunFile)\n- `use_canary_reporting?`: Whether to report errors via canary\n\nError templates receive `{{error_code}}` and `{{error_text}}` substitutions.\n\n```ts\nerror: {\n\terror_page: Bun.file('./templates/error.html'),\n\tuse_canary_reporting: true\n}\n```\n\n##### `static?: object`\nOptional static file serving configuration:\n- `route`: URL path prefix for static files\n- `directory`: Local directory containing static files\n- `sub_ext?`: Array of file extensions that should have template substitution applied\n\n```ts\nstatic: {\n\troute: '/assets',\n\tdirectory: './public',\n\tsub_ext: ['.css', '.js'] // These files get template processing\n}\n```\n\nFiles with extensions in `sub_ext` will have template substitutions applied before serving. This includes support for functions to generate dynamic content:\n\n```ts\n// Dynamic CSS with function-based substitutions\nstatic: {\n\troute: '/assets',\n\tdirectory: './public',\n\tsub_ext: ['.css']\n},\n\nglobal_subs: {\n\ttheme_color: () => {\n\t\tconst hour = new Date().getHours();\n\t\treturn hour < 6 || hour > 18 ? '#2d3748' : '#4a5568';\n\t}\n}\n```\n\nThis allows CSS files to use dynamic substitutions: `color: {{theme_color}};`\n\n##### `global_subs?: Record`\nOptional global template substitutions available to all routes, error pages, and static files with `sub_ext`.\n\n```ts\nglobal_subs: {\n\tsite_name: 'My Website',\n\tversion: '1.0.0',\n\tapi_url: 'https://api.example.com',\n\t\n\t// Function-based substitutions for dynamic content\n\tcurrent_year: () => new Date().getFullYear().toString(),\n\t\n\tbuild_time: async () => {\n\t\t// Example: fetch build timestamp from git\n\t\tconst process = Bun.spawn(['git', 'log', '-1', '--format=%ct']);\n\t\tconst output = await new Response(process.stdout).text();\n\t\treturn new Date(parseInt(output.trim()) * 1000).toISOString();\n\t},\n\t\n\tuser_count: async () => {\n\t\t// Example: dynamic user count from database\n\t\tconst count = await db.count('SELECT COUNT(*) as count FROM users');\n\t\treturn count.toLocaleString();\n\t}\n}\n```\n\nFunctions in `global_subs` and route-specific `subs` are called during template processing, allowing for dynamic content generation. Both synchronous and asynchronous functions are supported.\n\n#### Template Processing Order\n\n1. Route content is loaded\n2. If `base` is defined, content is wrapped using `{{content}}` substitution\n3. Route-specific `subs` and `global_subs` are applied\n4. Hash substitutions (if enabled) are applied\n\n\n## API > HTTP > Cookies\n\n### 🔧 `cookies_get(req: Request): Bun.CookieMap`\n\nWhen called on a request, the `cookies_get` function will return a `Bun.CookieMap` contains all of the cookies parsed from the `Cookie` header on the request.\n\n```ts\nserver.route('/', (req, url) => {\n\tconst cookies = cookies_get(req);\n\treturn `Hello ${cookies.get('person') ?? 'unknown'}`;\n});\n```\n\nThe return `Bun.CookieMap` is an iterable map with a custom API for reading/setting cookies. The full API [can be seen here](https://bun.com/docs/runtime/cookies).\n\nAny changes made to the cookie map (adding, deletion, editing, etc) will be sent as `Set-Cookie` headers on the response automatically. Unchanged cookies are not sent.\n\n```ts\nserver.route('/', (req, url) => {\n\tconst cookies = cookies_get(req);\n\tcookies.set('test', 'foobar');\n\treturn 'Hello, world!';\n\n\t// the response automatically gets:\n\t// Set-Cookie test=foobar; Path=/; SameSite=Lax\n});\n```\n\n\n## API > Error Handling\n\n### 🔧 `ErrorWithMetadata(message: string, metadata: object)`\n\nThe `ErrorWithMetadata` class allows you to attach metadata to errors, which can be used for debugging purposes when errors are dispatched to the canary.\n\n```ts\nthrow new ErrorWithMetadata('Something went wrong', { foo: 'bar' });\n```\n\nFunctions and promises contained in the metadata will be resolved and the return value will be used instead.\n\n```ts\nthrow new ErrorWithMetadata('Something went wrong', { foo: () => 'bar' });\n```\n\n### 🔧 `caution(err_message_or_obj: string | object, ...err: object[]): Promise`\n\nRaise a warning issue on GitHub. This is useful for non-fatal issues which you want to be notified about.\n\n> [!NOTE]\n> This function is only available if the canary feature is enabled.\n\n```ts\ntry {\n\t// Perform a non-critical action, such as analytics.\n\t// ...\n} catch (e) {\n\t// `caution` is async, you can use it without awaiting.\n\tcaution(e);\n}\n```\n\nAdditional data can be provided as objects which will be serialized to JSON and included in the report.\n\n```ts\ncaution(e, { foo: 42 });\n```\n\nA custom error message can be provided as the first parameter\n\n> [!NOTE]\n> Avoid including dynamic information in the title that would prevent the issue from being unique.\n\n```ts\ncaution('Custom error', e, { foo: 42 });\n```\n\nIssues raised with `caution()` are rate-limited. By default, the rate limit is `86400` seconds (24 hours), however this can be configured in the `spooder.canary.throttle` property.\n\n```json\n{\n\t\"spooder\": {\n\t\t\"canary\": {\n\t\t\t\"throttle\": 86400\n\t\t}\n\t}\n}\n```\n\nIssues are considered unique by the `err_message` parameter, so avoid using dynamic information that would prevent this from being unique.\n\nIf you need to provide unique information, you can use the `err` parameter to provide an object which will be serialized to JSON and included in the issue body.\n\n```ts\nconst some_important_value = Math.random();\n\n// Bad: Do not use dynamic information in err_message.\nawait caution('Error with number ' + some_important_value);\n\n// Good: Use err parameter to provide dynamic information.\nawait caution('Error with number', { some_important_value });\n```\n\n### 🔧 `panic(er","readmeFilename":"README.md"}
![](\"docs/project-logo.png\"/){kind=logo}
![](\"{{cache_bust=static/images/logo.png}}\"){kind=logo}
\n```\n\nSince this uses the [`cache_bust()`](#api-cache-busting) API internally, it is effected by the `cache_bust_set_hash_length` and `cache_bust_set_format` global functions.\n\nSetting `cache_bust` to `true` assumes the normal defaults, however this can be customized by providing an options object.\n\n```ts\ncache_bust: { // true or options\n\tformat: '$file#$hash', // default: $file?v=$hash\n\thash_length: 20, // default: 7\n\tprefix: 'bust' // default: cache_bust\n},\n```\n\n> ![IMPORTANT]\n> `format` and `hash_length` internally call `cache_bust_set_format` and `cache_bust_set_hash_length` respectively, so these values will effect `cache_bust()` globally.\n\n##### `error?: object`\nOptional error page configuration:\n- `error_page`: Template for error pages (string or BunFile)\n- `use_canary_reporting?`: Whether to report errors via canary\n\nError templates receive `{{error_code}}` and `{{error_text}}` substitutions.\n\n```ts\nerror: {\n\terror_page: Bun.file('./templates/error.html'),\n\tuse_canary_reporting: true\n}\n```\n\n##### `static?: object`\nOptional static file serving configuration:\n- `route`: URL path prefix for static files\n- `directory`: Local directory containing static files\n- `sub_ext?`: Array of file extensions that should have template substitution applied\n\n```ts\nstatic: {\n\troute: '/assets',\n\tdirectory: './public',\n\tsub_ext: ['.css', '.js'] // These files get template processing\n}\n```\n\nFiles with extensions in `sub_ext` will have template substitutions applied before serving. This includes support for functions to generate dynamic content:\n\n```ts\n// Dynamic CSS with function-based substitutions\nstatic: {\n\troute: '/assets',\n\tdirectory: './public',\n\tsub_ext: ['.css']\n},\n\nglobal_subs: {\n\ttheme_color: () => {\n\t\tconst hour = new Date().getHours();\n\t\treturn hour < 6 || hour > 18 ? '#2d3748' : '#4a5568';\n\t}\n}\n```\n\nThis allows CSS files to use dynamic substitutions: `color: {{theme_color}};`\n\n##### `global_subs?: Record