@e22m4u/ts-rest-router 0.1.0 → 0.1.2

package/README.md

@@ -1,27 +1,25 @@
 # @e22m4u/ts-rest-router
 
-*English | [Русский](./README-ru.md)*
+REST маршрутизатор на основе контроллеров для TypeScript.
 
-Controllers-based REST router implementation for TypeScript.
+#### Основные возможности
 
-#### Key Features
+- Декларативное определение маршрутов через декораторы.
+- Типизированные параметры запросов (body, query, params).
+- Поддержка middleware до и после обработки запроса.
+- Валидация входящих данных.
+- Поддержка всех HTTP методов (GET, POST, PUT, DELETE и т.д.).
 
-- Declarative route definition using decorators.
-- Typed request parameters (body, query, params).
-- Pre and post request middleware support.
-- Input data validation.
-- Support for all HTTP methods (GET, POST, PUT, DELETE, etc.).
-
-## Installation
+## Установка
 
 ```bash
 npm install @e22m4u/ts-rest-router
 ```
 
-#### Decorators support
+#### Поддержка декораторов
 
-To enable decorators support add the following
-options to your `tsconfig.json` file.
+Для включения поддержки декораторов, добавьте указанные
+ниже опции в файл `tsconfig.json` вашего проекта.
 
 ```json
 {
@@ -30,152 +28,152 @@ options to your `tsconfig.json` file.
 }
 ```
 
-## Basic Usage
+## Базовое использование
 
-Creating a controller and methods.
+Создание контроллера и методов
 
 ```ts
 import {get} from '@e22m4u/ts-rest-router';
 import {post} from '@e22m4u/ts-rest-router';
-import {bodyProp} from '@e22m4u/ts-rest-router';
+import {field} from '@e22m4u/ts-rest-router';
 import {DataType} from '@e22m4u/ts-rest-router';
 import {controller} from '@e22m4u/ts-rest-router';
 
-@controller('/users')        // controller path
-class UserController {       // controller class
-  @post('/login')            // POST /users/login method
+@controller('/users')         // путь контроллера
+class UserController {        // класс контроллера
+  @post('/login')             // метод POST /users/login
   async login(
-    @bodyProp('username', {  // "username" is request body property
-      type: DataType.STRING, // parameter type allows only strings
-      required: true,        // parameter is required
+    @field('username', {      // поле "username" в теле запроса
+      type: DataType.STRING,  // тип параметра допускает только строки
+      required: true,         // параметр является обязательным
     })
     username: string,
-    @bodyProp('password', {  // "password" is request body property
-      type: DataType.STRING, // parameter type allows only strings
-      required: true,        // parameter is required
+    @field('password', {      // поле "password" в теле запроса
+      type: DataType.STRING,  // тип параметра допускает только строки
+      required: true,         // параметр является обязательным
     })
     password: string,
   ) {
-    return {                 // if method returns an object,
-      id: '123',             // the result will be presented as
-      firstName: 'John',     // "Content-Type: application/json"
+    return {                  // если метод возвращает объект,
+      id: '123',              // то результат будет представлен как
+      firstName: 'John',      // "Content-Type: application/json"
       lastName: 'Doe',
     };
   }
 }
 ```
 
-Registering controllers and starting the server.
+Регистрация контроллеров и запуск сервера
 
 ```ts
 import http from 'http';
 import {RestRouter} from '@e22m4u/ts-rest-router';
 
-// create router and register controllers
+// создание роутера и регистрация контроллеров
 const router = new RestRouter();
 router.registerController(UserController);
 router.registerController(ProductController);
 
-// create server and register request handler
+// создание сервера и регистрация обработчика запросов
 const server = new http.Server();
 server.on('request', router.requestListener);
 
-// start server
+// запуск сервера
 server.listen('8080', '0.0.0.0', () => {
   console.log(`Server is running on http://localhost:8080`);
 });
 ```
 
-## Decorators
+## Декораторы
 
-Controller and methods:
+Контроллер и методы:
 
-- `@controller` - defines a class as a controller
-- `@action` - base decorator for methods
-- `@get` - GET requests
-- `@post` - POST requests
-- `@put` - PUT requests
-- `@patch` - PATCH requests
-- `@del` - DELETE requests
+- `@controller` - определяет класс как контроллер
+- `@action` - базовый декоратор для методов
+- `@get` - GET запросы
+- `@post` - POST запросы
+- `@put` - PUT запросы
+- `@patch` - PATCH запросы
+- `@del` - DELETE запросы
 
-Request hooks:
+Хуки запроса:
 
-- `@before` - middleware before request handling
-- `@after` - middleware after request handling
+- `@before` - middleware перед обработкой запроса
+- `@after` - middleware после обработки запроса
 
-Request parameters:
+Параметры запроса:
 
-- `@param` - single URL parameter
-- `@params` - all URL parameters as an object
-- `@query` - single query parameter
-- `@queries` - all query parameters as an object
-- `@body` - request body
-- `@bodyProp` - property from request body
-- `@header` - single header
-- `@headers` - all headers as an object
-- `@cookie` - single cookie
-- `@cookies` - all cookies as an object
-- `@requestContext` - access to request context
-- `@requestData` - universal decorator for accessing request data
+- `@param` - один параметр URL
+- `@params` - все параметры URL как объект
+- `@query` - один query параметр
+- `@queries` - все query параметры как объект
+- `@body` - тело запроса
+- `@field` - поле в теле запроса
+- `@header` - один заголовок
+- `@headers` - все заголовки как объект
+- `@cookie` - одна cookie
+- `@cookies` - все cookies как объект
+- `@requestContext` - доступ к контексту запроса
+- `@requestData` - универсальный декоратор для доступа к данным запроса
 
 #### `@controller(options?: ControllerOptions)`
 
-Defining a controller.
+Определение контроллера.
 
 ```ts
 @controller()
 class UserController {
-  // controller methods
+  // методы контроллера
 }
 ```
 
-Defining controller path.
+Определение пути контроллера.
 
 ```ts
-@controller('/users')  // controller path
+@controller('/users')  // путь контроллера
 class UserController {
-  // controller methods
+  // методы контроллера
 }
 ```
 
-Additional decorator parameters.
+Дополнительные параметры декоратора.
 
 ```ts
 @controller({
-  path: '/api',              // controller path
-  before: [authMiddleware],  // middleware before request processing
-  after: [loggerMiddleware], // middleware after request processing
+  path: '/api',              // путь контроллера
+  before: [authMiddleware],  // middleware до обработки запроса
+  after: [loggerMiddleware], // middleware после обработки запроса
 })
 class UserController {
-  // controller methods
+  // методы контроллера
 }
 ```
 
 #### `@get(path: string, options?: ActionOptions)`
 
-Defining GET method.
+Определение метода GET.
 
 ```ts
-@controller('/users')  // controller path
-class UserController { // controller class
-  @get('/whoAmI')      // GET /users/whoAmI route
+@controller('/users')  // путь контроллера
+class UserController { // класс контроллера
+  @get('/whoAmI')      // маршрут GET /users/whoAmI
   async whoAmI() {
-    return {           // if method returns an object,
-      name: 'John',    // the result will be presented
-      surname: 'Doe',  // as "Content-Type: application/json"
+    return {           // если метод возвращает объект,
+      name: 'John',    // то результат будет представлен
+      surname: 'Doe',  // как "Content-Type: application/json"
     };
   }
 }
 ```
 
-Additional decorator parameters.
+Дополнительные параметры декоратора.
 
 ```ts
-@controller('/users')          // controller path
-class UserController {         // controller class
-  @get('/whoAmI', {            // GET /users/whoAmI route
-    before: [authMiddleware],  // middleware before request processing
-    after: [loggerMiddleware], // middleware after request processing
+@controller('/users')          // путь контроллера
+class UserController {         // класс контроллера
+  @get('/whoAmI', {            // маршрут GET /users/whoAmI
+    before: [authMiddleware],  // middleware до обработки запроса
+    after: [loggerMiddleware], // middleware после обработки запроса
   })
   async whoAmI() {
     return {
@@ -188,17 +186,17 @@ class UserController {         // controller class
 
 #### `@requestContext(propertyName?: string)`
 
-Access to request context.
+Доступ к контексту запроса.
 
 ```ts
 import {RequestContext} from '@e22m4u/js-trie-router';
 
-@controller('/users')          // controller path
-class UserController {         // controller class
-  @get('/:id')                 // GET /users/:id route
+@controller('/users')          // путь контроллера
+class UserController {         // класс контроллера
+  @get('/:id')                 // маршрут GET /users/:id
   findById(
-    @requestContext()          // including request context
-    ctx: RequestContext,       // as method parameter
+    @requestContext()          // включениее контекста запроса
+    ctx: RequestContext,       // в качестве параметра метода
   ) {
     console.log(ctx.req);      // IncomingMessage
     console.log(ctx.res);      // ServerResponse
@@ -214,20 +212,20 @@ class UserController {         // controller class
 }
 ```
 
-Access to context properties.
+Доступ к свойствам контекста.
 
 ```ts
 import {ServerResponse} from 'http';
 import {IncomingMessage} from 'http';
 
-@controller('/users')      // controller path
-class UserController {     // controller class
-  @get('/:id')             // GET /users/:id route
+@controller('/users')      // путь контроллера
+class UserController {     // класс контроллера
+  @get('/:id')             // маршрут GET /users/:id
   findById(
-    @requestContext('req') // request context decorator
-    req: IncomingMessage,  // including "req" property
-    @requestContext('res') // request context decorator
-    res: ServerResponse,   // including "res" property
+    @requestContext('req') // декоратор контекста запроса
+    req: IncomingMessage,  // включающий свойство "req"
+    @requestContext('res') // декоратор контекста запроса
+    res: ServerResponse,   // включающий свойство "res"
   ) {
     console.log(req);      // IncomingMessage
     console.log(res);      // ServerResponse
@@ -235,34 +233,34 @@ class UserController {     // controller class
 }
 ```
 
-Context properties:
+Свойства контекста:
 
-- `container: ServiceContainer` instance of [service container](https://npmjs.com/package/@e22m4u/js-service)
-- `req: IncomingMessage` native incoming request stream
-- `res: ServerResponse` native server response stream
-- `params: ParsedParams` key-value object with path parameters
-- `query: ParsedQuery` key-value object with query string parameters
-- `headers: ParsedHeaders` key-value object with request headers
-- `cookie: ParsedCookie` key-value object of parsed `cookie` header
-- `method: string` request method in uppercase, e.g. `GET`, `POST`, etc.
-- `path: string` path including query string, e.g. `/myPath?foo=bar`
-- `pathname: string` request path, e.g. `/myMath`
-- `body: unknown` request body
+- `container: ServiceContainer` экземпляр [сервис-контейнера](https://npmjs.com/package/@e22m4u/js-service)
+- `req: IncomingMessage` нативный поток входящего запроса
+- `res: ServerResponse` нативный поток ответа сервера
+- `params: ParsedParams` объект ключ-значение с параметрами пути
+- `query: ParsedQuery` объект ключ-значение с параметрами строки запроса
+- `headers: ParsedHeaders` объект ключ-значение с заголовками запроса 
+- `cookie: ParsedCookie` объект ключ-значение разобранного заголовка `cookie`
+- `method: string` метод запроса в верхнем регистре, например `GET`, `POST` и т.д.
+- `path: string` путь включающий строку запроса, например `/myPath?foo=bar`
+- `pathname: string` путь запроса, например `/myMath`
+- `body: unknown` тело запроса
 
-## Debugging
+## Отладка
 
-Set the `DEBUG` variable to enable log output.
+Установка переменной `DEBUG` включает вывод логов.
 
 ```bash
 DEBUG=tsRestRouter* npm run test
 ```
 
-## Tests
+## Тесты
 
 ```bash
 npm run test
 ```
 
-## License
+## Лицензия
 
 MIT

package/dist/cjs/index.cjs

@@ -51,7 +51,6 @@ __export(index_exports, {
   after: () => after,
   before: () => before,
   body: () => body,
-  bodyProp: () => bodyProp,
   capitalize: () => capitalize,
   controller: () => controller,
   cookie: () => cookie,
@@ -59,6 +58,7 @@ __export(index_exports, {
   createDebugger: () => createDebugger,
   createError: () => createError,
   del: () => del,
+  field: () => field,
   get: () => get,
   header: () => header,
   headers: () => headers,
@@ -470,7 +470,7 @@ var headers = createRequestDataDecoratorWithSource(RequestDataSource.HEADERS);
 var header = createRequestDataPropertyDecoratorWithSource(RequestDataSource.HEADERS);
 var cookies = createRequestDataDecoratorWithSource(RequestDataSource.COOKIE);
 var cookie = createRequestDataPropertyDecoratorWithSource(RequestDataSource.COOKIE);
-var bodyProp = createRequestDataPropertyDecoratorWithSource(RequestDataSource.BODY);
+var field = createRequestDataPropertyDecoratorWithSource(RequestDataSource.BODY);
 function body(schemaOrType) {
   let schema;
   if (typeof schemaOrType === "object") {
@@ -959,7 +959,6 @@ var RestRouter = _RestRouter;
   after,
   before,
   body,
-  bodyProp,
   capitalize,
   controller,
   cookie,
@@ -967,6 +966,7 @@ var RestRouter = _RestRouter;
   createDebugger,
   createError,
   del,
+  field,
   get,
   header,
   headers,

package/dist/esm/decorators/request-data/request-data-decorator.d.ts

@@ -23,7 +23,7 @@ export declare const headers: () => (target: Prototype<object>, propertyKey: str
 export declare const header: (propertyKey: string, schemaOrType?: DataSchema | DataType) => (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
 export declare const cookies: () => (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
 export declare const cookie: (propertyKey: string, schemaOrType?: DataSchema | DataType) => (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
-export declare const bodyProp: (propertyKey: string, schemaOrType?: DataSchema | DataType) => (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
+export declare const field: (propertyKey: string, schemaOrType?: DataSchema | DataType) => (target: Prototype<object>, propertyKey: string, indexOrDescriptor: number) => void;
 /**
  * Request body decorator.
  *

package/dist/esm/decorators/request-data/request-data-decorator.js

@@ -63,7 +63,7 @@ export const headers = createRequestDataDecoratorWithSource(RequestDataSource.HE
 export const header = createRequestDataPropertyDecoratorWithSource(RequestDataSource.HEADERS);
 export const cookies = createRequestDataDecoratorWithSource(RequestDataSource.COOKIE);
 export const cookie = createRequestDataPropertyDecoratorWithSource(RequestDataSource.COOKIE);
-export const bodyProp = createRequestDataPropertyDecoratorWithSource(RequestDataSource.BODY);
+export const field = createRequestDataPropertyDecoratorWithSource(RequestDataSource.BODY);
 /**
  * Request body decorator.
  *

package/dist/esm/decorators/request-data/request-data-decorator.spec.js

@@ -16,13 +16,13 @@ import { DataType } from '@e22m4u/ts-data-schema';
 import { body } from './request-data-decorator.js';
 import { param } from './request-data-decorator.js';
 import { query } from './request-data-decorator.js';
+import { field } from './request-data-decorator.js';
 import { cookie } from './request-data-decorator.js';
 import { header } from './request-data-decorator.js';
 import { params } from './request-data-decorator.js';
 import { queries } from './request-data-decorator.js';
 import { cookies } from './request-data-decorator.js';
 import { headers } from './request-data-decorator.js';
-import { bodyProp } from './request-data-decorator.js';
 import { requestData } from './request-data-decorator.js';
 import { RequestDataSource } from './request-data-metadata.js';
 import { RequestDataReflector } from './request-data-reflector.js';
@@ -460,13 +460,13 @@ describe('requestData', function () {
                 });
             });
         });
-        describe('bodyProp', function () {
+        describe('field', function () {
             it('sets a given "propertyKey" to the target metadata', function () {
                 class Target {
                     myMethod(prop) { }
                 }
                 __decorate([
-                    __param(0, bodyProp('myPropertyKey')),
+                    __param(0, field('myPropertyKey')),
                     __metadata("design:type", Function),
                     __metadata("design:paramtypes", [Object]),
                     __metadata("design:returntype", void 0)
@@ -485,7 +485,7 @@ describe('requestData', function () {
                     myMethod(prop) { }
                 }
                 __decorate([
-                    __param(0, bodyProp(propertyKey, propertyType)),
+                    __param(0, field(propertyKey, propertyType)),
                     __metadata("design:type", Function),
                     __metadata("design:paramtypes", [Object]),
                     __metadata("design:returntype", void 0)
@@ -514,7 +514,7 @@ describe('requestData', function () {
                     myMethod(prop) { }
                 }
                 __decorate([
-                    __param(0, bodyProp(propertyKey, schema)),
+                    __param(0, field(propertyKey, schema)),
                     __metadata("design:type", Function),
                     __metadata("design:paramtypes", [Object]),
                     __metadata("design:returntype", void 0)

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@e22m4u/ts-rest-router",
-  "version": "0.1.0",
-  "description": "Controllers-based REST router implementation for TypeScript",
+  "version": "0.1.2",
+  "description": "REST маршрутизатор на основе контроллеров для TypeScript",
   "author": "e22m4u <e22m4u@yandex.ru>",
+  "license": "MIT",
   "keywords": [
     "rest",
     "http",
@@ -49,28 +50,27 @@
     "http-errors": "~2.0.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "~19.6.1",
-    "@commitlint/config-conventional": "~19.6.0",
-    "@eslint/js": "~9.17.0",
-    "@types/chai": "~5.0.1",
+    "@commitlint/cli": "~19.8.0",
+    "@commitlint/config-conventional": "~19.8.0",
+    "@eslint/js": "~9.25.1",
+    "@types/chai": "~5.2.1",
     "@types/debug": "~4.1.12",
     "@types/http-errors": "~2.0.4",
     "@types/mocha": "~10.0.10",
-    "@types/node": "~22.10.2",
+    "@types/node": "~22.14.1",
     "c8": "~10.1.3",
-    "chai": "~5.1.2",
-    "esbuild": "~0.24.2",
-    "eslint": "~9.17.0",
-    "eslint-config-prettier": "~9.1.0",
+    "chai": "~5.2.0",
+    "esbuild": "~0.25.3",
+    "eslint": "~9.25.1",
+    "eslint-config-prettier": "~10.1.2",
     "eslint-plugin-chai-expect": "~3.1.0",
     "eslint-plugin-mocha": "~10.5.0",
     "husky": "~9.1.7",
-    "mocha": "~11.0.1",
-    "prettier": "~3.4.2",
+    "mocha": "~11.1.0",
+    "prettier": "~3.5.3",
     "rimraf": "~6.0.1",
-    "tsx": "~4.19.2",
-    "typescript": "~5.7.2",
-    "typescript-eslint": "~8.18.2"
-  },
-  "license": "MIT"
+    "tsx": "~4.19.3",
+    "typescript": "~5.8.3",
+    "typescript-eslint": "~8.31.0"
+  }
 }

package/src/controller-registry.spec.ts

@@ -6,6 +6,7 @@ import {body} from './decorators/index.js';
 import {after} from './decorators/index.js';
 import {query} from './decorators/index.js';
 import {param} from './decorators/index.js';
+import {field} from './decorators/index.js';
 import {cookie} from './decorators/index.js';
 import {params} from './decorators/index.js';
 import {before} from './decorators/index.js';
@@ -13,7 +14,6 @@ import {header} from './decorators/index.js';
 import {cookies} from './decorators/index.js';
 import {queries} from './decorators/index.js';
 import {headers} from './decorators/index.js';
-import {bodyProp} from './decorators/index.js';
 import {HookName} from '@e22m4u/js-trie-router';
 import {controller} from './decorators/index.js';
 import {TrieRouter} from '@e22m4u/js-trie-router';
@@ -31,13 +31,9 @@ import {ControllerRegistry} from './controller-registry.js';
 
 const PRE_HANDLER_1 = () => undefined;
 const PRE_HANDLER_2 = () => undefined;
-// const PRE_HANDLER_3 = () => undefined;
-// const PRE_HANDLER_4 = () => undefined;
 
 const POST_HANDLER_1 = () => undefined;
 const POST_HANDLER_2 = () => undefined;
-// const POST_HANDLER_3 = () => undefined;
-// const POST_HANDLER_4 = () => undefined;
 
 describe('ControllerRegistry', function () {
   it('has a public property with set of controllers', function () {
@@ -872,7 +868,7 @@ describe('ControllerRegistry', function () {
       class MyController {
         @post('/myAction')
         myAction(
-          @bodyProp('foo')
+          @field('foo')
           foo: object,
         ) {
           expect(foo).to.be.eq('bar');

package/src/decorators/request-data/request-data-decorator.spec.ts

@@ -4,13 +4,13 @@ import {DataType} from '@e22m4u/ts-data-schema';
 import {body} from './request-data-decorator.js';
 import {param} from './request-data-decorator.js';
 import {query} from './request-data-decorator.js';
+import {field} from './request-data-decorator.js';
 import {cookie} from './request-data-decorator.js';
 import {header} from './request-data-decorator.js';
 import {params} from './request-data-decorator.js';
 import {queries} from './request-data-decorator.js';
 import {cookies} from './request-data-decorator.js';
 import {headers} from './request-data-decorator.js';
-import {bodyProp} from './request-data-decorator.js';
 import {requestData} from './request-data-decorator.js';
 import {RequestDataSource} from './request-data-metadata.js';
 import {RequestDataReflector} from './request-data-reflector.js';
@@ -409,11 +409,11 @@ describe('requestData', function () {
       });
     });
 
-    describe('bodyProp', function () {
+    describe('field', function () {
       it('sets a given "propertyKey" to the target metadata', function () {
         class Target {
           myMethod(
-            @bodyProp('myPropertyKey')
+            @field('myPropertyKey')
             prop: unknown,
           ) {}
         }
@@ -430,7 +430,7 @@ describe('requestData', function () {
         const propertyType = DataType.STRING;
         class Target {
           myMethod(
-            @bodyProp(propertyKey, propertyType)
+            @field(propertyKey, propertyType)
             prop: unknown,
           ) {}
         }
@@ -457,7 +457,7 @@ describe('requestData', function () {
         const propertyKey = 'myPropertyKey';
         class Target {
           myMethod(
-            @bodyProp(propertyKey, schema)
+            @field(propertyKey, schema)
             prop: unknown,
           ) {}
         }

package/src/decorators/request-data/request-data-decorator.ts

@@ -109,7 +109,7 @@ export const cookies = createRequestDataDecoratorWithSource(
 export const cookie = createRequestDataPropertyDecoratorWithSource(
   RequestDataSource.COOKIE,
 );
-export const bodyProp = createRequestDataPropertyDecoratorWithSource(
+export const field = createRequestDataPropertyDecoratorWithSource(
   RequestDataSource.BODY,
 );
 

package/README-ru.md

@@ -1,268 +0,0 @@
-# @e22m4u/ts-rest-router
-
-*[English](./README.md) | Русский*
-
-Реализация REST маршрутизатора на основе контроллеров для TypeScript.
-
-#### Основные возможности
-
-- Декларативное определение маршрутов через декораторы.
-- Типизированные параметры запросов (body, query, params).
-- Поддержка middleware до и после обработки запроса.
-- Валидация входящих данных.
-- Поддержка всех HTTP методов (GET, POST, PUT, DELETE и т.д.).
-
-## Установка
-
-```bash
-npm install @e22m4u/ts-rest-router
-```
-
-#### Поддержка декораторов
-
-Для включения поддержки декораторов, добавьте указанные
-ниже опции в файл `tsconfig.json` вашего проекта.
-
-```json
-{
-  "emitDecoratorMetadata": true,
-  "experimentalDecorators": true
-}
-```
-
-## Базовое использование
-
-Создание контроллера и методов
-
-```ts
-import {get} from '@e22m4u/ts-rest-router';
-import {post} from '@e22m4u/ts-rest-router';
-import {bodyProp} from '@e22m4u/ts-rest-router';
-import {DataType} from '@e22m4u/ts-rest-router';
-import {controller} from '@e22m4u/ts-rest-router';
-
-@controller('/users')         // путь контроллера
-class UserController {        // класс контроллера
-  @post('/login')             // метод POST /users/login
-  async login(
-    @bodyProp('username', {   // свойство тела запроса "username"
-      type: DataType.STRING,  // тип параметра допускает только строки
-      required: true,         // параметр является обязательным
-    })
-    username: string,
-    @bodyProp('password', {   // свойство тела запроса "password"
-      type: DataType.STRING,  // тип параметра допускает только строки
-      required: true,         // параметр является обязательным
-    })
-    password: string,
-  ) {
-    return {                  // если метод возвращает объект,
-      id: '123',              // то результат будет представлен как
-      firstName: 'John',      // "Content-Type: application/json"
-      lastName: 'Doe',
-    };
-  }
-}
-```
-
-Регистрация контроллеров и запуск сервера
-
-```ts
-import http from 'http';
-import {RestRouter} from '@e22m4u/ts-rest-router';
-
-// создание роутера и регистрация контроллеров
-const router = new RestRouter();
-router.registerController(UserController);
-router.registerController(ProductController);
-
-// создание сервера и регистрация обработчика запросов
-const server = new http.Server();
-server.on('request', router.requestListener);
-
-// запуск сервера
-server.listen('8080', '0.0.0.0', () => {
-  console.log(`Server is running on http://localhost:8080`);
-});
-```
-
-## Декораторы
-
-Контроллер и методы:
-
-- `@controller` - определяет класс как контроллер
-- `@action` - базовый декоратор для методов
-- `@get` - GET запросы
-- `@post` - POST запросы
-- `@put` - PUT запросы
-- `@patch` - PATCH запросы
-- `@del` - DELETE запросы
-
-Хуки запроса:
-
-- `@before` - middleware перед обработкой запроса
-- `@after` - middleware после обработки запроса
-
-Параметры запроса:
-
-- `@param` - один параметр URL
-- `@params` - все параметры URL как объект
-- `@query` - один query параметр
-- `@queries` - все query параметры как объект
-- `@body` - тело запроса
-- `@bodyProp` - свойство из тела запроса
-- `@header` - один заголовок
-- `@headers` - все заголовки как объект
-- `@cookie` - одна cookie
-- `@cookies` - все cookies как объект
-- `@requestContext` - доступ к контексту запроса
-- `@requestData` - универсальный декоратор для доступа к данным запроса
-
-#### `@controller(options?: ControllerOptions)`
-
-Определение контроллера.
-
-```ts
-@controller()
-class UserController {
-  // методы контроллера
-}
-```
-
-Определение пути контроллера.
-
-```ts
-@controller('/users')  // путь контроллера
-class UserController {
-  // методы контроллера
-}
-```
-
-Дополнительные параметры декоратора.
-
-```ts
-@controller({
-  path: '/api',              // путь контроллера
-  before: [authMiddleware],  // middleware до обработки запроса
-  after: [loggerMiddleware], // middleware после обработки запроса
-})
-class UserController {
-  // методы контроллера
-}
-```
-
-#### `@get(path: string, options?: ActionOptions)`
-
-Определение метода GET.
-
-```ts
-@controller('/users')  // путь контроллера
-class UserController { // класс контроллера
-  @get('/whoAmI')      // маршрут GET /users/whoAmI
-  async whoAmI() {
-    return {           // если метод возвращает объект,
-      name: 'John',    // то результат будет представлен
-      surname: 'Doe',  // как "Content-Type: application/json"
-    };
-  }
-}
-```
-
-Дополнительные параметры декоратора.
-
-```ts
-@controller('/users')          // путь контроллера
-class UserController {         // класс контроллера
-  @get('/whoAmI', {            // маршрут GET /users/whoAmI
-    before: [authMiddleware],  // middleware до обработки запроса
-    after: [loggerMiddleware], // middleware после обработки запроса
-  })
-  async whoAmI() {
-    return {
-      name: 'John',
-      surname: 'Doe',
-    };
-  }
-}
-```
-
-#### `@requestContext(propertyName?: string)`
-
-Доступ к контексту запроса.
-
-```ts
-import {RequestContext} from '@e22m4u/js-trie-router';
-
-@controller('/users')          // путь контроллера
-class UserController {         // класс контроллера
-  @get('/:id')                 // маршрут GET /users/:id
-  findById(
-    @requestContext()          // включениее контекста запроса
-    ctx: RequestContext,       // в качестве параметра метода
-  ) {
-    console.log(ctx.req);      // IncomingMessage
-    console.log(ctx.res);      // ServerResponse
-    console.log(ctx.params);   // {id: 10}
-    console.log(ctx.query);    // {include: 'city'}
-    console.log(ctx.headers);  // {cookie: 'foo=bar; baz=qux;'}
-    console.log(ctx.cookie);   // {foo: 'bar', baz: 'qux'}
-    console.log(ctx.method);   // "GET"
-    console.log(ctx.path);     // "/users/10?include=city"
-    console.log(ctx.pathname); // "/users/10"
-    // ...
-  }
-}
-```
-
-Доступ к свойствам контекста.
-
-```ts
-import {ServerResponse} from 'http';
-import {IncomingMessage} from 'http';
-
-@controller('/users')      // путь контроллера
-class UserController {     // класс контроллера
-  @get('/:id')             // маршрут GET /users/:id
-  findById(
-    @requestContext('req') // декоратор контекста запроса
-    req: IncomingMessage,  // включающий свойство "req"
-    @requestContext('res') // декоратор контекста запроса
-    res: ServerResponse,   // включающий свойство "res"
-  ) {
-    console.log(req);      // IncomingMessage
-    console.log(res);      // ServerResponse
-  }
-}
-```
-
-Свойства контекста:
-
-- `container: ServiceContainer` экземпляр [сервис-контейнера](https://npmjs.com/package/@e22m4u/js-service)
-- `req: IncomingMessage` нативный поток входящего запроса
-- `res: ServerResponse` нативный поток ответа сервера
-- `params: ParsedParams` объект ключ-значение с параметрами пути
-- `query: ParsedQuery` объект ключ-значение с параметрами строки запроса
-- `headers: ParsedHeaders` объект ключ-значение с заголовками запроса 
-- `cookie: ParsedCookie` объект ключ-значение разобранного заголовка `cookie`
-- `method: string` метод запроса в верхнем регистре, например `GET`, `POST` и т.д.
-- `path: string` путь включающий строку запроса, например `/myPath?foo=bar`
-- `pathname: string` путь запроса, например `/myMath`
-- `body: unknown` тело запроса
-
-## Отладка
-
-Установка переменной `DEBUG` включает вывод логов.
-
-```bash
-DEBUG=tsRestRouter* npm run test
-```
-
-## Тесты
-
-```bash
-npm run test
-```
-
-## Лицензия
-
-MIT