File size: 2,137 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
import type { RouteMatch } from '../route-matches/route-match'
import type { RouteMatcherProvider } from '../route-matcher-providers/route-matcher-provider'
import type { LocaleAnalysisResult } from '../lib/i18n-provider'
export type MatchOptions = {
skipDynamic?: boolean
/**
* If defined, this indicates to the matcher that the request should be
* treated as locale-aware. If this is undefined, it means that this
* application was not configured for additional locales.
*/
i18n?: LocaleAnalysisResult | undefined
}
export interface RouteMatcherManager {
/**
* Returns a promise that resolves when the matcher manager has finished
* reloading.
*/
waitTillReady(): Promise<void>
/**
* Pushes in a new matcher for this manager to manage. After all the
* providers have been pushed, the manager must be reloaded.
*
* @param provider the provider for this manager to also manage
*/
push(provider: RouteMatcherProvider): void
/**
* Reloads the matchers from the providers. This should be done after all the
* providers have been added or the underlying providers should be refreshed.
*/
reload(): Promise<void>
/**
* Tests the underlying matchers to find a match. It does not return the
* match.
*
* @param pathname the pathname to test for matches
* @param options the options for the testing
*/
test(pathname: string, options: MatchOptions): Promise<boolean>
/**
* Returns the first match for a given request.
*
* @param pathname the pathname to match against
* @param options the options for the matching
*/
match(pathname: string, options: MatchOptions): Promise<RouteMatch | null>
/**
* Returns a generator for each match for a given request. This should be
* consumed in a `for await (...)` loop, when finished, breaking or returning
* from the loop will terminate the matching operation.
*
* @param pathname the pathname to match against
* @param options the options for the matching
*/
matchAll(
pathname: string,
options: MatchOptions
): AsyncGenerator<RouteMatch, null, undefined>
}
|