API

init()

1 await router.init();

Registriert alle bekannten Routes bei @xpulse/http.

register(method, path, handler, name = null, namePrefix = null, pathPrefix = null)

1 router.register('GET', '/info', handler);
2 router.register('GET', '/info/:page?', handler);

Optional mit Default-Params (Legacy-Signatur):

1 router.register('GET', '/tool/:tool/:page?', handler, { tool: 'chat', page: 'guide' });

Kompatibilitaet: Wenn das 4. Argument ein Object ist und keine Prefixe uebergeben werden, wird es als Legacy-defaults behandelt. Fuer Namen/Prefixe die neue Signatur nutzen.

Optional mit Name und Prefixen:

1 router.register('GET', '/info', handler, 'info.index', 'app', null);
2 router.register('GET', '/web-profiler/:traceId/dashboard/', handler, 'web-profiler.traceId.dashboard', 'debug', '/_debug');

Prefixe

Auto-generierte Routenamen starten standardmaessig mit app. und enthalten keine HTTP-Methode. Du kannst die Default-Prefixe ueber xpulse.json ueberschreiben:

1 {
2   "router": {
3     "name-prefix": "app",
4     "path-prefix": ""
5   }
6 }

Pro Package kannst du Prefixe direkt beim Registern setzen:

1 router.register('GET', '/web-profiler/:traceId/dashboard/', handler, 'web-profiler.traceId.dashboard', 'debug', '/_debug');

notFound(handler)

1 router.notFound((req, res) => {
2     res.status(404).send('Nicht gefunden');
3 });

getPath(pattern, params)

1 const path = router.getPath('/tool/:tool/:page?', { tool: 'chat' });
2 // -> /tool/chat/guide/ (defaults greifen)

list()

1 const routes = router.list();
2 // {
3 //   'info.index': { name, method, path, handler, defaults }
4 // }

Events

router:matched – wird emittiert wenn eine Route matched
Payload: { method, path, params, name, traceId }

1	router.register('GET', '/info', handler);
2	router.register('GET', '/info/:page?', handler);

1	router.register('GET', '/info', handler, 'info.index', 'app', null);
2	router.register('GET', '/web-profiler/:traceId/dashboard/', handler, 'web-profiler.traceId.dashboard', 'debug', '/_debug');

1	router.notFound((req, res) => {
2	res.status(404).send('Nicht gefunden');
3	});

1	const path = router.getPath('/tool/:tool/:page?', { tool: 'chat' });
2	// -> /tool/chat/guide/ (defaults greifen)

1	const routes = router.list();
2	// {
3	// 'info.index': { name, method, path, handler, defaults }
4	// }