Class GouterLinking<T>

Provides tools to decode and encode urls.

Type Parameters

Index

Constructors

constructor

new GouterLinking<T>(routes, create): GouterLinking<T>
Creates GouterLinking using required routes and create.
Type Parameters
- T extends GouterConfig
Parameters
- routes: Routes<T>
  map of names to route configurations
- create: (<N>(name, params, stack?, focusedIndex?) => GouterState<T, N>)
  tool for new states with stack auto-building
  - - <N>(name, params, stack?, focusedIndex?): GouterState<T, N>
    - Creates state using required name, params and optional stack. When stack is not passed and routes has appropriate builder, new stack is generated using that builder.
      
      Type Parameters
      N extends string | number | symbol
      Parameters
      name: N
      string to distinguish states
      
      params: T[N]
      collection of parameters to customize states
      
      Optional stack: GouterState<T, keyof T>[]
      optional list of inner states
      
      Optional focusedIndex: number
      optional index of focused state in stack
      
      Returns GouterState<T, N>
Returns GouterLinking<T>
- Defined in linking/index.js:13

Properties

`Protected` create

create: (<N>(name, params, stack?, focusedIndex?) => GouterState<T, N>)

tool for new states with stack auto-building used in decodeUrl

Type declaration

- <N>(name, params, stack?, focusedIndex?): GouterState<T, N>
- tool for new states with stack auto-building used in decodeUrl
  Type Parameters
  - N extends string | number | symbol
  Parameters
  - name: N
  - params: T[N]
  - Optional stack: GouterState<T, keyof T>[]
  - Optional focusedIndex: number
  Returns GouterState<T, N>

`Protected` pathRegexpByName

pathRegexpByName: {
[N in string | number | symbol]?: RegExp
}

Cache to speed up decodePath.

`Protected` routes

routes: Routes<T>

map of names to route configurations

Methods

decodePath

decodePath<N>(name, pathStr): null | Partial<T[N]>
Creates path parameters from route name and url path string or returns null if no route matched.
Type Parameters
- N extends string | number | symbol
Parameters
- name: N
- pathStr: string
Returns null | Partial<T[N]>
- Defined in linking/index.js:231

decodeQuery

decodeQuery<N>(name, queryStr): Partial<T[N]>
Creates query parameters from route name and url query string.
Type Parameters
- N extends string | number | symbol
Parameters
- name: N
- queryStr: string
Returns Partial<T[N]>
- Defined in linking/index.js:286

decodeUrl

decodeUrl(url): null | GouterState<T, keyof T>
Creates state from url or returns null if no route matched.
Parameters
- url: string
Returns null | GouterState<T, keyof T>
- Defined in linking/index.js:332

encodePath

encodePath<N>(name, params): string
Creates url path string from state name and params. Uses = to escape params which equal to next path key and also to represent empty string.
Type Parameters
- N extends string | number | symbol
Parameters
- name: N
- params: Partial<T[N]>
Returns string
- Defined in linking/index.js:56

encodeQuery

encodeQuery<N>(name, params): string
Creates url query string from state name and params. Uses / to represent empty array for params with list: true.
Type Parameters
- N extends string | number | symbol
Parameters
- name: N
- params: Partial<T[N]>
Returns string
- Defined in linking/index.js:131

encodeUrl

encodeUrl(state): string
Creates url from state using it's name and params.
Parameters
- state: GouterState<T, keyof T>
Returns string
- Defined in linking/index.js:172

`Protected` getPathRegexp

getPathRegexp(name): RegExp
Protected
Get path regexp for route name.
Parameters
- name: keyof T
Returns RegExp
- Defined in linking/index.js:186

`Protected` safeEncodeURIComponent

safeEncodeURIComponent(uriComponent): string
Protected
Safely encodes a text string as a valid component of a Uniform Resource Identifier (URI).
Parameters
- uriComponent: string
Returns string
- Defined in linking/index.js:44

Class GouterLinking<T>

Type Parameters

T

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends GouterConfig

Parameters

routes: Routes<T>

create: (<N>(name, params, stack?, focusedIndex?) => GouterState<T, N>)

Type Parameters

N extends string | number | symbol

Parameters

name: N

params: T[N]

Optional stack: GouterState<T, keyof T>[]

Optional focusedIndex: number

Returns GouterState<T, N>

Returns GouterLinking<T>

Properties

Protected create

Type declaration

Type Parameters

N extends string | number | symbol

Parameters

name: N

params: T[N]

Optional stack: GouterState<T, keyof T>[]

Optional focusedIndex: number

Returns GouterState<T, N>

Protected pathRegexpByName

Protected routes

Methods

decodePath

Type Parameters

N extends string | number | symbol

Parameters

name: N

pathStr: string

Returns null | Partial<T[N]>

decodeQuery

Type Parameters

N extends string | number | symbol

Parameters

name: N

queryStr: string

Returns Partial<T[N]>

decodeUrl

Parameters

url: string

Returns null | GouterState<T, keyof T>

encodePath

Type Parameters

N extends string | number | symbol

Parameters

name: N

params: Partial<T[N]>

Returns string

encodeQuery

Type Parameters

N extends string | number | symbol

Parameters

name: N

params: Partial<T[N]>

Returns string

encodeUrl

Parameters

state: GouterState<T, keyof T>

Returns string

Protected getPathRegexp

Parameters

name: keyof T

Returns RegExp

Protected safeEncodeURIComponent

Parameters

uriComponent: string

`Optional` stack: GouterState<T, keyof T>[]

`Optional` focusedIndex: number

`Protected` create

`Optional` stack: GouterState<T, keyof T>[]

`Optional` focusedIndex: number

`Protected` pathRegexpByName

`Protected` routes

`Protected` getPathRegexp

`Protected` safeEncodeURIComponent