Browse Source

docs: updates README.md

e22m4u 3 weeks ago
parent
commit
e72d329304
1 changed files with 9 additions and 7 deletions
  1. 9 7
      README.md

+ 9 - 7
README.md

@@ -53,15 +53,15 @@ const {TrieRouter} = require('@e22m4u/js-trie-router');
 
 
 ```js
 ```js
 import http from 'http';
 import http from 'http';
-import {TrieRouter} from '@e22m4u/js-trie-router';
+import {TrieRouter, HttpMethod} from '@e22m4u/js-trie-router';
 
 
 const server = new http.Server(); // создание экземпляра HTTP сервера
 const server = new http.Server(); // создание экземпляра HTTP сервера
 const router = new TrieRouter();  // создание экземпляра роутера
 const router = new TrieRouter();  // создание экземпляра роутера
 
 
 router.defineRoute({
 router.defineRoute({
-  method: 'GET',                  // метод запроса "GET", "POST" и т.д.
-  path: '/',                      // шаблон пути, пример "/user/:id"
-  handler(ctx) {                  // обработчик маршрута
+  method: HttpMethod.GET,   // метод запроса "GET", "POST" и т.д.
+  path: '/',                // шаблон пути, пример "/user/:id"
+  handler(ctx) {            // обработчик маршрута
     return 'Hello world!';
     return 'Hello world!';
   },
   },
 });
 });
@@ -72,6 +72,8 @@ server.listen(3000, 'localhost');             // прослушивание за
 // Open in browser http://localhost:3000
 // Open in browser http://localhost:3000
 ```
 ```
 
 
+*i. Для указания метода запроса рекомендуется использовать экспортируемую константу `HttpMethod`, чтобы избежать опечаток.*
+
 ### Контекст запроса
 ### Контекст запроса
 
 
 Первый параметр обработчика маршрута принимает экземпляр класса
 Первый параметр обработчика маршрута принимает экземпляр класса
@@ -99,7 +101,7 @@ server.listen(3000, 'localhost');             // прослушивание за
 
 
 ```js
 ```js
 router.defineRoute({
 router.defineRoute({
-  method: 'GET',
+  method: HttpMethod.GET,
   path: '/users/:id',
   path: '/users/:id',
   meta: {prop: 'value'},
   meta: {prop: 'value'},
   handler(ctx) {
   handler(ctx) {
@@ -272,7 +274,7 @@ router.addPostHandler((ctx, data) => {
 
 
 ```js
 ```js
 import http from 'http';
 import http from 'http';
-import {TrieRouter} from '@e22m4u/js-trie-router';
+import {TrieRouter, HttpMethod} from '@e22m4u/js-trie-router';
 
 
 const server = new http.Server();
 const server = new http.Server();
 const router = new TrieRouter();
 const router = new TrieRouter();
@@ -285,7 +287,7 @@ router.addPreHandler((ctx) => {
 });
 });
 
 
 router.defineRoute({
 router.defineRoute({
-  method: 'GET',
+  method: HttpMethod.GET,
   path: '/',
   path: '/',
   meta: {foo: 'bar'}, // <= мета-данные
   meta: {foo: 'bar'}, // <= мета-данные
   handler(ctx) {
   handler(ctx) {