Interface Router<Locales, RouteRef>

interface Router<Locales, RouteRef> {
    find: ((path, locale?) => null | RouteMatch<Locales, RouteRef>);
    get: ((key) => EndRoute<Locales, RouteRef>);
    toLocalizedPath: ((locale, key, args?) => string);
    toPath: ((key, args?) => string);
}

Type Parameters

Locales extends LocaleType | never
RouteRef

Index

Properties

find get toLocalizedPath toPath

Properties

find

find: ((path, locale?) => null | RouteMatch<Locales, RouteRef>)

Type declaration

- (path, locale?): null | RouteMatch<Locales, RouteRef>
- Parameters
  - path: string
  - Optional locale: Locales
  Returns null | RouteMatch<Locales, RouteRef>

get

get: ((key) => EndRoute<Locales, RouteRef>)

Type declaration

- (key): EndRoute<Locales, RouteRef>
- Parameters
  - key: string
  Returns EndRoute<Locales, RouteRef>

toLocalizedPath

toLocalizedPath: ((locale, key, args?) => string)

Type declaration

- (locale, key, args?): string
- Parameters
  - locale: Locales
  - key: string
  - Optional args: any
  Returns string

toPath

toPath: ((key, args?) => string)

Type declaration

- (key, args?): string
- Parameters
  - key: string
  - Optional args: any
  Returns string