Class: StaticRoute
@ima/core.StaticRoute
Utility for representing and manipulating a single static route in the
router's configuration using string representation of the path expression
with special param fields identified by :paramName
prefix.
Hierarchy
↳
StaticRoute
Constructors
constructor
• new StaticRoute(name
, pathExpression
, controller
, view
, options
)
Inherit Doc
Parameters
Name | Type | Description |
---|---|---|
name | string | - |
pathExpression | string | A path expression specifying the URL path part matching this route (must not contain a query string), optionally containing named parameter placeholders specified as :parameterName . |
controller | string | typeof Controller | () => IController | - |
view | unknown | - |
options | RouteOptions | - |
Overrides
Defined in
packages/core/src/router/StaticRoute.ts:96
Properties
_cachedController
• Protected
_cachedController: unknown
Inherited from
AbstractRoute._cachedController
Defined in
packages/core/src/router/AbstractRoute.ts:53
_cachedView
• Protected
_cachedView: unknown
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:54
_controller
• Protected
_controller: string
| typeof Controller
| () => IController
The full name of Object Container alias identifying the controller associated with this route.
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:43
_hasParameters
• Protected
_hasParameters: boolean
Defined in
packages/core/src/router/StaticRoute.ts:86
_matcher
• Protected
_matcher: RegExp
Defined in
packages/core/src/router/StaticRoute.ts:87
_name
• Protected
_name: string
The unique name of this route, identifying it among the rest of the routes in the application.
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:33
_options
• Protected
_options: RouteOptions
The route additional options.
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:52
_parameterNames
• Protected
_parameterNames: string
[]
Defined in
packages/core/src/router/StaticRoute.ts:85
_pathExpression
• Protected
_pathExpression: string
| RoutePathExpression
Path expression used in route matching, to generate valid path with provided params and parsing params from current path.
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:38
_trimmedPathExpression
• Protected
_trimmedPathExpression: string
Defined in
packages/core/src/router/StaticRoute.ts:84
_view
• Protected
_view: unknown
The full name or Object Container alias identifying the view class associated with this route.
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:48
Methods
_checkOptionalParamsOrder
▸ _checkOptionalParamsOrder(allMainParams
): boolean
Check if all optional params are below required ones
Parameters
Name | Type |
---|---|
allMainParams | string [] |
Returns
boolean
Defined in
packages/core/src/router/StaticRoute.ts:267
_checkParametersOrder
▸ _checkParametersOrder(clearedPathExpr
): boolean
Check if main parameters have correct order. It means that required param cannot follow optional one.
Parameters
Name | Type | Description |
---|---|---|
clearedPathExpr | string | The cleared URL path (removed first and last slash, ...). |
Returns
boolean
Returns TRUE if order is correct.
Defined in
packages/core/src/router/StaticRoute.ts:293
_cleanOptParamName
▸ _cleanOptParamName(paramName
): string
Returns optional param name without "?"
Parameters
Name | Type | Description |
---|---|---|
paramName | string | Full param name with "?" |
Returns
string
Strict param name without "?"
Defined in
packages/core/src/router/StaticRoute.ts:524
_cleanUnusedOptionalParams
▸ _cleanUnusedOptionalParams(path
): string
Remove unused optional param placeholders in path.
Parameters
Name | Type |
---|---|
path | string |
Returns
string
Defined in
packages/core/src/router/StaticRoute.ts:211
_compileToRegExp
▸ _compileToRegExp(pathExpression
): RegExp
Compiles the path expression to a regular expression that can be used for easier matching of URL paths against this route, and extracting the path parameter values from the URL path.
Parameters
Name | Type | Description |
---|---|---|
pathExpression | string | The path expression to compile. |
Returns
RegExp
The compiled regular expression.
Defined in
packages/core/src/router/StaticRoute.ts:408
_extractParameters
▸ _extractParameters(parameterValues
): StringParameters
Extract parameters from given path.
Parameters
Name | Type |
---|---|
parameterValues | string [] |
Returns
Defined in
packages/core/src/router/StaticRoute.ts:496
_getAsyncModule
▸ _getAsyncModule(module
): unknown
Helper method to pre-process view and controller which can be async functions in order to support dynamic async routing.
Parameters
Name | Type | Description |
---|---|---|
module | unknown | The module class/alias/constant. |
Returns
unknown
Module, or promise resolving to the actual view or controller constructor function/class.
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:362
_getClearParamName
▸ _getClearParamName(rawParam
): string
Extract clear parameter name, e.q. '?name' or 'name'
Parameters
Name | Type |
---|---|
rawParam | string |
Returns
string
Defined in
packages/core/src/router/StaticRoute.ts:247
_getParameterNames
▸ _getParameterNames(pathExpression
): string
[]
Extracts the parameter names from the provided path expression.
Parameters
Name | Type | Description |
---|---|---|
pathExpression | string | The path expression. |
Returns
string
[]
The names of the parameters defined in the provided path expression.
Defined in
packages/core/src/router/StaticRoute.ts:545
_getParameters
▸ _getParameters(path
): StringParameters
Parses the provided path and extract the in-path parameters. The method decodes the parameters and returns them in a hash object.
Parameters
Name | Type |
---|---|
path | string |
Returns
Defined in
packages/core/src/router/StaticRoute.ts:478
_getSubparamPattern
▸ _getSubparamPattern(delimiter
): string
Get pattern for subparameter.
Parameters
Name | Type |
---|---|
delimiter | string |
Returns
string
Defined in
packages/core/src/router/StaticRoute.ts:258
_isOptionalParamInPath
▸ _isOptionalParamInPath(path
, paramName
): boolean
Returns true, if paramName is placed in path.
Parameters
Name | Type |
---|---|
path | string |
paramName | string |
Returns
boolean
Defined in
packages/core/src/router/StaticRoute.ts:229
_isParamOptional
▸ _isParamOptional(paramName
): boolean
Checks if parameter is optional or not.
Parameters
Name | Type |
---|---|
paramName | string |
Returns
boolean
return true if is optional, otherwise false
Defined in
packages/core/src/router/StaticRoute.ts:534
_isRequiredParamInPath
▸ _isRequiredParamInPath(path
, paramName
): boolean
Returns true, if paramName is placed in path and it's required.
Parameters
Name | Type |
---|---|
path | string |
paramName | string |
Returns
boolean
Defined in
packages/core/src/router/StaticRoute.ts:238
_replaceOptionalParametersInPath
▸ _replaceOptionalParametersInPath(path
, optionalParams
): string
Convert main optional parameters to capture sequences
Parameters
Name | Type | Description |
---|---|---|
path | string | The URL path. |
optionalParams | string [] | List of main optimal parameter expressions |
Returns
string
RegExp pattern.
Defined in
packages/core/src/router/StaticRoute.ts:311
_replaceOptionalSubParametersInPath
▸ _replaceOptionalSubParametersInPath(path
, optionalSubparamsOthers
, optionalSubparamsLast
): string
Convert optional subparameters to capture sequences
Parameters
Name | Type | Description |
---|---|---|
path | string | The URL path (route definition). |
optionalSubparamsOthers | string [] | List of all subparam. expressions but last ones |
optionalSubparamsLast | string [] | List of last subparam. expressions |
Returns
string
RegExp pattern.
Defined in
packages/core/src/router/StaticRoute.ts:376
_replaceRequiredSubParametersInPath
▸ _replaceRequiredSubParametersInPath(path
, clearedPathExpr
): string
Convert required subparameters to capture sequences
Parameters
Name | Type | Description |
---|---|---|
path | string | The URL path (route definition). |
clearedPathExpr | string | The original cleared URL path. |
Returns
string
RegExp pattern.
Defined in
packages/core/src/router/StaticRoute.ts:343
_substituteOptionalParamInPath
▸ _substituteOptionalParamInPath(path
, paramName
, paramValue
): string
Replace optional param placeholder in path with parameter value.
Parameters
Name | Type |
---|---|
path | string |
paramName | string |
paramValue | ParamValue |
Returns
string
Defined in
packages/core/src/router/StaticRoute.ts:196
_substituteRequiredParamInPath
▸ _substituteRequiredParamInPath(path
, paramName
, paramValue
): string
Replace required parameter placeholder in path with parameter value.
Parameters
Name | Type |
---|---|
path | string |
paramName | string |
paramValue | ParamValue |
Returns
string
Defined in
packages/core/src/router/StaticRoute.ts:182
extractParameters
▸ extractParameters(path
): StringParameters
& RouteParams
Extracts the parameter values from the provided path. The method extracts both the in-path parameters and parses the query, allowing the query parameters to override the in-path parameters.
The method returns an empty hash object if the path does not match this route.
Parameters
Name | Type |
---|---|
path | string |
Returns
StringParameters
& RouteParams
Map of parameter names to parameter values.
Overrides
AbstractRoute.extractParameters
Defined in
packages/core/src/router/StaticRoute.ts:171
getController
▸ getController(): unknown
Returns Controller class/alias/constant associated with this route. Internally caches async calls for dynamically imported controllers, meaning that once they're loaded, you get the same promise for subsequent calls.
Returns
unknown
The Controller class/alias/constant.
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:251
getName
▸ getName(): string
Returns the unique identifying name of this route.
Returns
string
The name of the route, identifying it.
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:239
getOptions
▸ getOptions(): RouteOptions
Return route additional options.
Returns
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:278
getPathExpression
▸ getPathExpression(): string
| RoutePathExpression
Path expression used in route matching, to generate valid path with provided params and parsing params from current path.
Returns
string
| RoutePathExpression
The path expression.
Inherited from
AbstractRoute.getPathExpression
Defined in
packages/core/src/router/AbstractRoute.ts:288
getView
▸ getView(): unknown
Returns View class/alias/constant associated with this route. Internally caches async calls for dynamically imported views, meaning that once they're loaded, you get the same promise for subsequent calls.
Returns
unknown
The View class/alias/constant.
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:267
matches
▸ matches(path
): boolean
Tests whether the provided URL path matches this route. The provided path may contain the query.
Parameters
Name | Type | Description |
---|---|---|
path | string | The URL path. |
Returns
boolean
true
if the provided path matches this route.
Overrides
Defined in
packages/core/src/router/StaticRoute.ts:162
preload
▸ preload(): Promise
<[unknown
, unknown
]>
Preloads dynamically imported view and controller.
Returns
Promise
<[unknown
, unknown
]>
Promise.All resolving to [view, controller] tuple.
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:297
toPath
▸ toPath(params?
): string
Creates the URL and query parts of a URL by substituting the route's parameter placeholders by the provided parameter value.
The extraneous parameters that do not match any of the route's placeholders will be appended as the query string.
Parameters
Name | Type | Description |
---|---|---|
params | RouteParams | The route parameter values. |
Returns
string
Path and, if necessary, query parts of the URL representing this route with its parameters replaced by the provided parameter values.
Overrides
Defined in
packages/core/src/router/StaticRoute.ts:131
decodeURIParameter
▸ Static
decodeURIParameter(parameterValue
): string
TODO IMA@18 remove static method
Decoding parameters.
Parameters
Name | Type |
---|---|
parameterValue | string |
Returns
string
decodedValue
Inherited from
AbstractRoute.decodeURIParameter
Defined in
packages/core/src/router/AbstractRoute.ts:168
getQuery
▸ Static
getQuery(path
): RouteParams
TODO IMA@18 remove static method
Extracts and decodes the query parameters from the provided URL path and query.
Parameters
Name | Type | Description |
---|---|---|
path | string | The URL path, including the optional query string (if any). |
Returns
RouteParams
Parsed query parameters.
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:123
getTrimmedPath
▸ Static
getTrimmedPath(path
): string
TODO IMA@18 remove static method
Trims the trailing forward slash from the provided URL path.
Parameters
Name | Type | Description |
---|---|---|
path | string | The path to trim. |
Returns
string
Trimmed path.
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:184
pairsToQuery
▸ Static
pairsToQuery(pairs?
): string
TODO IMA@18 remove static method
Converts array of pairs (tuples) into valid URI query component. Filters out invalid inputs (undefined, null, object, array, non-pair).
Example
let pairs = [['a', true], ['hello world', 123]];
pairsToQuery(pairs); // => "?a=true&hello%20world=123"
Parameters
Name | Type | Default value | Description |
---|---|---|---|
pairs? | unknown [][] | [] | Array of arrays where the first element must be string|number and the second element can be any. |
Returns
string
Valid URI query component or empty string if there are no valid pairs provided.
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:71
paramsToQuery
▸ Static
paramsToQuery(params?
): string
TODO IMA@18 remove static method
Converts object of key/value pairs to URI query, which can be appended to url.
Parameters
Name | Type |
---|---|
params | RouteParams |
Returns
string