Plugin for [µWebSockets.js](https://github.com/uNetworking/uWebSockets.js) that autoloads all routes in a directory.
npm install uws-autoloadPlugin for µWebSockets.js that autoloads all routes in a directory.
Inspired by elysia-autoload.
``sh`
yarn add uws-autoload
`ts
import { App } from 'uWebSockets.js'
import { autoloadRoutes } from 'uws-autoload'
const port = +(process.env.PORT || 3000)
const app = await autoloadRoutes(App(), {
// Pattern to scan route files
pattern: '*/.ts',
// Prefix to add to routes
prefix: '/api',
// Source directory of route files: use "relative" path
routesDir: './src/api'
})
app.listen(port, (listenSocket) => {
if (listenSocket) {
console.log(Server running at http://localhost:${port})Failed to listen to port ${port}
} else {
console.log()`
}
})
`ts
// /routes/index.ts
import type { TemplatedApp } from 'uWebSockets.js'
export default ((res, req) => {
res.end('Hello World!')
}) satisfies Parameters
`
Guide on how uws-autoload matches routes:
`
├── app.ts
├── routes
│ ├── index.ts // index routes
│ ├── posts
│ │ ├── index.ts
│ │ └── [id].ts // dynamic params
│ ├── likes
│ │ └── [...].ts // wildcard
│ ├── domains
│ │ ├── @[...] // wildcard with @ prefix
│ │ │ └── index.ts
│ ├── frontend
│ │ └── index.tsx // usage of tsx extension
│ ├── events
│ │ ├── (post).ts // post and get will not be in the link
│ │ └── (get).ts
│ └── users.ts
└── package.json
- /routes/index.ts → /
- → /posts
- → /posts/:id
- → /users
- → /likes/*
- → /domains/@*
- → /frontend
- → /events
- → /events
| Key | Type | Default | Description |
| ----------------- | ------- | ------------------------------ | ----------------------------------------------------------------- |
| failGlob? | boolean | true | Throws an error if no matches are found |default
| importKey? | string | | The key (name) of the exported function of route files |*/.{ts,tsx,js,jsx,mjs,cjs}
| pattern? | string | | Glob patterns) |
| prefix? | string | | Prefix to be added to each route |./routes
| routesDir? | string | | The folder where routes are located (use a relative path) |false
| skipImportErrors? | boolean | | Throws an error if there is an import error of a route file |
+ Node.js and similar use cases, where .ts or .tsx files aren't transpiled, install esbuild.Note:
>
Bun` internally transpiles every file it executes (both .js and .ts) → Read moreThis project is licensed under the MIT License.