params | @uirouter/core

Module params

This module contains code for State Parameters.

See ParamDeclaration

Index

Enumerations

DefType

Classes

Interfaces

Functions

Functions

ArrayType(type: ParamType, mode: boolean | "auto"): void
Wraps up a ParamType object to handle array values.

Wraps up a ParamType object to handle array values.

Parameters
- type ParamType
- mode boolean | "auto"
Returns void
- Defined in private/var/folders/4n/ys7v20b52y9gyyx7kfdb93580000gp/T/tmp-16028wEw5zOIy63UQ/ui-router-core/src/params/paramType.ts:105

getParamDeclaration(paramName: string, location: DefType, state: StateDeclaration): ParamDeclaration

Parameters
- paramName string
- location DefType
- state StateDeclaration
Returns ParamDeclaration
- Defined in private/var/folders/4n/ys7v20b52y9gyyx7kfdb93580000gp/T/tmp-16028wEw5zOIy63UQ/ui-router-core/src/params/param.ts:28

getReplace(config: ParamDeclaration, arrayMode: boolean, isOptional: boolean, squash: string | boolean): object[]

Parameters
- config ParamDeclaration
- arrayMode boolean
- isOptional boolean
- squash string | boolean
Returns object[]
- Defined in private/var/folders/4n/ys7v20b52y9gyyx7kfdb93580000gp/T/tmp-16028wEw5zOIy63UQ/ui-router-core/src/params/param.ts:82

getSquashPolicy(config: ParamDeclaration, isOptional: boolean, defaultPolicy: boolean | string): string | false | true

Parameters
- config ParamDeclaration
- isOptional boolean
- defaultPolicy boolean | string
Returns string | false | true
- Defined in private/var/folders/4n/ys7v20b52y9gyyx7kfdb93580000gp/T/tmp-16028wEw5zOIy63UQ/ui-router-core/src/params/param.ts:73

Generated using TypeDoc