@e22m4u/js-trie-router 0.4.3 → 0.5.0

package/.mocharc.json

@@ -0,0 +1,5 @@
+{
+  "extension": ["js"],
+  "spec": "src/**/*.spec.js",
+  "require": "./mocha.setup.js"
+}

package/README.md

@@ -22,7 +22,8 @@ HTTP маршрутизатор для Node.js на основе
     - [preHandler](#prehandler)
     - [postHandler](#posthandler)
   - [Глобальные хуки](#глобальные-хуки)
-  - [Метаданные](#метаданные)
+  - [Метаданные маршрута](#метаданные-маршрута)
+  - [Состояние запроса](#состояние-запроса)
 - [Отладка](#отладка)
 - [Тестирование](#тестирование)
 - [Лицензия](#лицензия)
@@ -100,6 +101,7 @@ server.listen(3000, 'localhost');             // прослушивание за
 - `response: ServerResponse` нативный поток ответа сервера;
 - `route: Route` экземпляр текущего маршрута;
 - `meta: object` геттер для доступа к метаданным маршрута (`route.meta`);
+- `state: object` объект для обмена данными между хуками и обработчиком;
 
 Пример доступа к контексту из обработчика маршрута.
 
@@ -124,6 +126,7 @@ router.defineRoute({
     console.log(ctx.response);  // ServerResponse
     console.log(ctx.route);     // Route
     console.log(ctx.meta);      // {prop: 'value'}
+    console.log(ctx.state);     // {}
     // ...
   },
 });
@@ -265,7 +268,7 @@ router.addPostHandler((ctx, data) => {
 отличное от `undefined` и `null`, то такое значение будет использовано
 как ответ сервера.
 
-### Метаданные
+### Метаданные маршрута
 
 Иногда требуется связать с маршрутом дополнительные, статические данные, которые
 могут быть использованы хуками для расширения функционала. Например, это могут
@@ -293,7 +296,7 @@ router.addPreHandler((ctx) => {
 router.defineRoute({
   method: HttpMethod.GET,
   path: '/',
-  meta: {foo: 'bar'}, // <= мета-данные
+  meta: {foo: 'bar'}, // <= метаданные
   handler(ctx) {
     return 'Hello World!';
   },
@@ -303,6 +306,38 @@ server.on('request', router.requestListener);
 server.listen(3000, 'localhost');
 ```
 
+### Состояние запроса
+
+Объект `ctx.state` инициализируется как пустой объект `{}` для каждого нового
+запроса. Он предназначен для передачи динамических данных (например, профиля
+пользователя после авторизации) из `preHandler` хуков в основной обработчик
+маршрута или `postHandler` хуки.
+
+```js
+import http from 'http';
+import {TrieRouter, HttpMethod} from '@e22m4u/js-trie-router';
+
+const router = new TrieRouter();
+
+// глобальный хук авторизации
+router.addPreHandler((ctx) => {
+  // логика получения пользователя (например, из заголовков)
+  const user = {id: 1, name: 'John', role: 'admin'};
+  // сохранение данных в state
+  ctx.state.user = user;
+});
+
+router.defineRoute({
+  method: HttpMethod.GET,
+  path: '/profile',
+  handler(ctx) {
+    // доступ к данным, установленным в хуке
+    const user = ctx.state.user;
+    return `Hello, ${user.name}!`;
+  },
+});
+```
+
 ## Отладка
 
 Установка переменной `DEBUG` включает вывод логов.