elysia-autoload
Plugin for Elysia which autoload all routes in directory and code-generate types for Eden
Currently, Eden types generation is broken!!
Installation
bun create elysiajs <directory-name>
and select Autoload
in plugins
Manual
bun install elysia-autoload
Usage
Register the plugin
import { Elysia } from "elysia";
import { autoload } from "elysia-autoload";
const app = new Elysia().use(autoload()).listen(3000);
export type ElysiaApp = typeof app;
Create route
import type { ElysiaApp } from "app";
export default (app: ElysiaApp) => app.get("/", { hello: "world" });
Directory structure
Guide how elysia-autoload
match 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
└── users.ts
└── package.json
- /routes/index.ts → /
- /routes/posts/index.ts → /posts
- /routes/posts/[id].ts → /posts/:id
- /routes/users.ts → /users
- /routes/likes/[...].ts → /likes/*
- /routes/domains/@[...]/index.ts → /domains/@*
- /routes/frontend/index.tsx → /frontend
Options
Key | Type | Default | Description |
---|
pattern? | string | "**/*.{ts,tsx,js,jsx,mjs,cjs}" | Glob patterns |
dir? | string | "./routes" | The folder where routes are located |
prefix? | string | | Prefix for routes |
types? | boolean | Types Options | false | Options to configure type code-generation. if boolean - enables/disables generation |
schema? | Function | | Handler for providing routes guard schema |
Types Options
Key | Type | Default | Description |
---|
output? | string | string[] | "./routes-types.ts" | Type code-generation output. It can be an array |
typeName? | string | "Routes" | Name for code-generated global type for Eden |
useExport? | boolean | false | Use export instead of global type |
Usage of types code-generation for Eden
import { Elysia } from "elysia";
import { autoload } from "elysia-autoload";
const app = new Elysia()
.use(
autoload({
types: {
output: "./routes.ts",
typeName: "Routes",
},
})
)
.listen(3000);
export type ElysiaApp = typeof app;
import { edenTreaty } from "@elysiajs/eden";
const app = edenTreaty<Routes>("http://localhost:3002");
const { data } = await app.test["some-path-param"].get({
$query: {
key: 2,
},
});
console.log(data);
Example of app with types code-generation you can see in example
Usage of schema handler
import swagger from "@elysiajs/swagger";
import Elysia from "elysia";
import { autoload } from "elysia-autoload";
const app = new Elysia()
.use(
autoload({
schema: ({ path, url }) => {
const tag = url.split("/").at(1)!;
return {
beforeHandle: ({ request }) => {
console.log(request.url);
},
detail: {
description: `Route autoloaded from ${path}`,
tags: [tag],
},
};
},
})
)
.use(swagger());
export type ElysiaApp = typeof app;
app.listen(3001, console.log);