Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/e22m4u/js-path-trie
A router for Node.js based on a prefix tree
https://github.com/e22m4u/js-path-trie
esm javascript nodejs path prefix-tree routing trie typescript
Last synced: 3 days ago
JSON representation
A router for Node.js based on a prefix tree
- Host: GitHub
- URL: https://github.com/e22m4u/js-path-trie
- Owner: e22m4u
- License: mit
- Created: 2024-08-24T15:26:51.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2024-11-09T07:29:52.000Z (6 days ago)
- Last Synced: 2024-11-09T08:24:15.861Z (6 days ago)
- Topics: esm, javascript, nodejs, path, prefix-tree, routing, trie, typescript
- Language: JavaScript
- Homepage:
- Size: 47.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-ru.md
- License: LICENSE
Awesome Lists containing this project
README
## @e22m4u/js-path-trie
*[English](./README.md) | Русский*
Маршрутизатор для Node.js на основе
[префиксного дерева](https://ru.wikipedia.org/wiki/Trie) (trie).
- Использует [path-to-regexp](https://github.com/pillarjs/path-to-regexp) синтаксис.
- Поддерживает параметры маршрута.
## Установка
Требуется Node.js 16 и выше.
```bash
npm install @e22m4u/js-path-trie
```
Модуль поддерживает ESM и CommonJS стандарты.
*ESM*
```js
import {PathTrie} from '@e22m4u/js-path-trie';
```
*CommonJS*
```js
const {PathTrie} = require('@e22m4u/js-path-trie');
```
## Обзор
Класс `PathTrie` имеет следующие методы:
- `add(pathTemplate: string, value: unknown)` добавить значение к новому маршруту
- `match(path: string)` поиск значения по заданному маршруту
Пример:
```js
import {PathTrie} from '@e22m4u/js-path-trie';
const trie = new PathTrie();
// добавление маршрутов выполняется
// методом "add", который принимает
// шаблон маршрута и его значение
trie.add('/foo/bar', yourValue1);
trie.add('/foo/:p1/bar/:p2', yourValue2);
// для поиска значения используется
// метод "match", который возвращает
// значение маршрута и его параметры
trie.match('/foo/bar');
// {
// value: yourValue1,
// params: {}
// }
// если маршрут имеет параметры,
// то их значения вернуться
// в результате поиска
trie.match('/foo/10/bar/20');
// {
// value: yourValue2,
// params: {p1: 10, p2: 20}
// }
// если маршрут не найден,
// то возвращается "undefined"
trie.match('/foo/bar/baz');
// undefined
```
## Отладка
Установка переменной `DEBUG` включает вывод логов.
```bash
DEBUG=jsPathTrie* npm run test
```
## Тестирование
```bash
npm run test
```
## Лицензия
MIT