Project routee

Index

Type aliases

Functions

Type aliases

ExecutorParameters

ExecutorParameters<T>: SanitizeRouteParameters<Record<T[number], string>>

Type parameters

T: Array<string>

RouteExecutor

RouteExecutor<P, D>: (parameters: ExecutorParameters<P>, data: Partial<D>) => void

Type parameters

P: Array<string>
D: Record<any, any>

Type declaration

- (parameters: ExecutorParameters<P>, data: Partial<D>): void
- Parameters
  - parameters: ExecutorParameters<P>
  - data: Partial<D>
  Returns void

RouteInterface

RouteInterface<Segments, Data>: { executor: RouteExecutor<Segments, Data>; id: string; segments: Segments }

Type parameters

Segments: Array<string>
Data: Record<string, any> = undefined

Type declaration

executor: RouteExecutor<Segments, Data>
id: string
segments: Segments

Functions

Const createURL

createURL<P>(route: RouteInterface<P>, parameters: ExecutorParameters<P>): string

- Defined in index.ts:63
Create an URL for the route with the given parameters.

Type parameters
- P: string[]
Parameters
- route: RouteInterface<P>
- parameters: ExecutorParameters<P>
Returns string

Const dispatch

dispatch(location: string): RouteInterface<any> | undefined

- Defined in index.ts:87
Dispatch a location to the corresponding route, if any, and return that route.

Parameters
- location: string
Returns RouteInterface<any> | undefined

Const registerRoute

registerRoute<P, D>(id: string, segments: Keys<P> | Array<undefined>, executor: RouteExecutor<Keys<P> | Array<undefined>, D>): RouteInterface<Keys<P>, D>

- Defined in index.ts:41
Create and register a route.

Type parameters
- P
- D
Parameters
- id: string
- segments: Keys<P> | Array<undefined>
- executor: RouteExecutor<Keys<P> | Array<undefined>, D>
Returns RouteInterface<Keys<P>, D>

Generated using TypeDoc