damex 1.1.6 → 2.0.1

package/README.md

@@ -1,15 +1,59 @@
-# dexpress
+## Decorators
 
-To install dependencies:
+### Used in Classes
 
-```bash
-bun install
+```typescript
+    @Controller
 ```
 
-To run:
+Receives a string indicating the route of the controller.
 
-```bash
-bun run src/server.ts
+```typescript
+    @GlobalMiddleware
 ```
 
-This project was created using `bun init` in bun v1.2.1. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
+Receives an array with all the middleware methods that will be applied to all the methods of the controller.
+
+### Used in Methods
+
+```typescript
+    @Get - path: string
+    @Post - path: string
+    @Put - path: string
+    @Patch - path: string
+    @Delete - path: string
+    @Middleware - Array with methods
+```
+
+#### Example
+
+```typescript
+@Controller('/users')
+@GlobalMiddleware([auth])
+export class UsersController {
+    constructor() {}
+
+    @Get()
+    @Middleware([logger])
+    getAll(req: Request, res: Response) {
+        res.status(200).send([
+            { id: 1, user: 'admin' },
+            { id: 2, user: 'default' },
+        ]);
+    }
+
+    @Get('/:id')
+    @Middleware([anotherLogger])
+    getById(req: Request, res: Response) {
+        console.log('request accepted...');
+
+        res.status(200).send([
+            { id: 1, user: 'admin' },
+            { id: 2, user: 'default' },
+        ]);
+    }
+}
+```
+
+# Warning!
+This package doesn't work with dependency injection for now. Because of this, and due to the way the routes are implemented, all services used inside controllers or other services must implement as static methods.