elysia-decorators - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #typescript #llm #go #deep-learning #docker #macos #java #vue #awesome-list #mcp

elysia-decorators

(★ 87)

Decorators support plugin for Elysia

파일 탐색기

최종 버전 다운로드 (.zip)

- - npm-publish.yml
- - TestController.ts
- index.ts
- - Controller.ts
  - Factory.ts
- ControllerManager.ts
- index.ts
- types.ts
- utils.ts
- index.test.ts
.eslintrc.js
.gitignore
.npmignore
bun.lockb
LICENSE
package.json
README.md
tsconfig.json

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/gaurishhs/elysia-decorators

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd elysia-decorators

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm start

개발/실행 서버를 켭니다.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# elysia-decorators

![badge](https://github.com/gaurishhs/elysia-decorators/actions/workflows/npm-publish.yml/badge.svg)

- This plugin adds decorator and controller-based routing support to elysia.

> **Note:**
> You need to enable [experimentalDecorators](https://www.typescriptlang.org/tsconfig#experimentalDecorators) compiler option for this plugin to work.

Please consider starring the project to show your ❤️ and support.

## Installation

Requires Bun v1.0.14 when using file-based controllers due to dependence on `Bun.Glob` introduced in v1.0.14.

```bash
bun add elysia-decorators
```

## Example

- [Demo](https://github.com/gaurishhs/elysia-decorators/tree/main/demo)

```ts
import { Controller, Get, decorators } from "elysia-decorators";
import { Elysia } from "elysia";

// /users prefix
@Controller("/users")
class UsersController {
  @Get()
  index() {
    return "Hello World";
  }
}

const app = new Elysia();

app.use(
  decorators({
    controllers: [UsersController],
  })
);

app.listen(3000);
```

## Documentation

Note: When using File-based controllers Bun v1.0.14 or more is required since it depends on `Bun.Glob`

### Controller Decorator

The `Controller` decorator is used to mark a class as a controller. It takes a string as an argument which is the prefix for all the routes in that controller. The prefix can be empty.

```ts
@Controller("/users")
class UsersController {
  // ...
}
```

---

### Method Decorators

The method decorators are used to mark a method as a route. They take a string as an argument which is the path for the route. The path can be empty.

```ts
@Controller("/users")
class UsersController {
  @Get()
  index() {
    // ...
  }
}
```

The above code will create a route at `/users` which will respond to `GET` requests.

---

### Custom Decorator

You can use a custom method as well by using the `Custom` decorator.

```ts
@Controller("/users")
class UsersController {
  @Custom("M-SEARCH", "/")
  index() {
    // ...
  }
}
```

The above code will create a route at `/users` which will respond to `M-SEARCH` requests.

## License

- This project is licensed under the MIT License - see the LICENSE file for details