Быстрый старт

Следуйте этим простым шагам, чтобы быстро начать использовать route-peek в своём приложении.

Установка

Вы можете установить route-peek с помощью менеджера пакетов JavaScript:

npm

npm add route-peek

pnpm

pnpm add route-peek

yarn

yarn add route-peek

bun

bun add route-peek

Примечание о совместимости

Пожалуйста, убедитесь, что в вашем проекте установлен Node.js версии 18 или выше.

Использование

Импортируйте route-peek в ваш проект:

index.ts

import { RouteMatcherBuilder } from 'route-peek';

Определите маршруты, которые вы хотите сопоставить:

index.ts

import { RouteMatcherBuilder } from 'route-peek';

const builder = new RouteMatcherBuilder(); 

builder.add('/');
builder.add('/users/{id:[0-9]+}');

const matcher = builder.build();

Используйте созданный экземпляр для сопоставления URL и извлечения параметров:

index.ts

import { RouteMatcherBuilder } from 'route-peek';

const builder = new RouteMatcherBuilder();

builder.add('/');
builder.add('/users/{id:[0-9]+}');

const matcher = builder.build();
const matchedRoutes = matcher.match('/users/123'); 

for (const matchedRoute of matchedRoutes) {
  console.log(matchedRoute);
}