0
0
mirror of https://github.com/honojs/hono.git synced 2024-12-01 11:51:01 +01:00
hono/deno_dist/router.ts
Taku Amano ec94acd909
feat: one params per a handler (optimized for RegExpRouter) (#1566)
Co-authored-by: Yusuke Wada <yusuke@kamawada.com>
2023-10-16 08:39:37 +09:00

41 lines
1.1 KiB
TypeScript

export const METHOD_NAME_ALL = 'ALL' as const
export const METHOD_NAME_ALL_LOWERCASE = 'all' as const
export const METHODS = ['get', 'post', 'put', 'delete', 'options', 'patch'] as const
export interface Router<T> {
name: string
add(method: string, path: string, handler: T): void
match(method: string, path: string): Result<T>
}
export type ParamIndexMap = Record<string, number>
export type ParamStash = string[]
export type Params = Record<string, string>
export type Result<T> = [[T, ParamIndexMap][], ParamStash] | [[T, Params][]]
/*
The router returns the result of `match` in either format.
[[handler, paramIndexMap][], paramArray]
e.g.
[
[
[middlewareA, {}], // '*'
[funcA, {'id': 0}], // '/user/:id/*'
[funcB, {'id': 0, 'action': 1}], // '/user/:id/:action'
],
['123', 'abc']
]
[[handler, params][]]
e.g.
[
[
[middlewareA, {}], // '*'
[funcA, {'id': '123'}], // '/user/:id/*'
[funcB, {'id': '123', 'action': 'abc'}], // '/user/:id/:action'
]
]
*/
export class UnsupportedPathError extends Error {}