A configuration object which contains the custom type definition. The object's
properties will override the default methods and/or pattern in ParamType's public interface.
a new ParamType object
Dynamic flag
When dynamic is true, changes to the parameter value will not cause the state to be entered/exited.
Normally, if a parameter value changes, the state which declared that the parameter will be reloaded (entered/exited).
When a parameter is dynamic, a transition still occurs, but it does not cause the state to exit/enter.
Default: false
Enables/disables inheriting of parameter values (of this type)
When a transition is run with TransitionOptions.inherit set to
true, the current param values are inherited in the new transition.
However, parameters whose type has inherit: false set will not be inherited.
The internal parameter type of hash has inherit: false.
This is used to disable inheriting of the hash value (#) on subsequent transitions.
$state.go('home', { '#': 'inboxAnchor' });
...
// "#" is not inherited.
// The value of the "#" parameter will be `null`
// The url's hash will be cleared.
$state.go('home.nest');
See also TransitionOptions.inherit and ParamDeclaration.inherit
The name/id of the parameter type
A regular expression that matches the encoded parameter type
This regular expression is used to match an encoded parameter value in the URL.
For example, if your type encodes as a dash-separated numbers, match that here:
new RegExp("[0-9]+(?:-[0-9]+)*").
There are some limitations to these regexps:
(?: ))/^foo$/Disables url-encoding of parameter values
If a parameter type is declared raw, it will not be url-encoded.
Custom encoding can still be applied in the encode function.
The decoding behavior of raw parameters is not defined. See: ParamDeclaration.raw for details
Wraps an existing custom ParamType as an array of ParamType, depending on 'mode'. e.g.:
mode is "auto", thenWraps an existing custom ParamType as an array of ParamType, depending on 'mode'. e.g.:
mode is "auto", thenGiven an encoded string, or a decoded object, returns a decoded object
Given an encoded string, or a decoded object, returns a decoded object
Decodes a parameter value string (from URL string or transition param) to a custom/native value.
Decodes a parameter value string (from URL string or transition param) to a custom/native value.
For example, if your type decodes to an array of ints, then decode the string as an array of ints here:
decode: (str) => str.split("-").map(str => parseInt(str, 10))
Note: in general, encode and decode should be symmetrical. That is, encode(decode(str)) === str
a custom representation of the URL parameter value.
Encodes a custom/native type value to a string that can be embedded in a URL.
Encodes a custom/native type value to a string that can be embedded in a URL.
Note that the return value does not need to be URL-safe (i.e. passed through encodeURIComponent()).
It only needs to be a representation of val that has been encoded as a string.
For example, if your custom type decodes to an array of ints, then encode the array of ints to a string here:
encode: (intarray) => intarray.join("-")
Note: in general, encode and decode should be symmetrical. That is, encode(decode(str)) === str
a string representation of val that can be encoded in a URL.
Determines whether two decoded values are equivalent.
Determines whether two decoded values are equivalent.
For example, if your type decodes to an array of ints, then check if the arrays are equal:
equals: (a, b) => a.length === b.length && a.reduce((acc, x, idx) => acc && x === b[idx], true)
true if the values are equivalent/equal, otherwise false.
Tests if some object type is compatible with this parameter type
Tests if some object type is compatible with this parameter type
Detects whether some value is of this particular type.
Accepts a decoded value and determines whether it matches this ParamType object.
If your custom type encodes the parameter to a specific type, check for that type here. For example, if your custom type decodes the URL parameter value as an array of ints, return true if the input is an array of ints:
is: (val) => Array.isArray(val) && array.reduce((acc, x) => acc && parseInt(val, 10) === val, true)
If your type decodes the URL parameter value to a custom string, check that the string matches
the pattern (don't use an arrow fn if you need this): function (val) { return !!this.pattern.exec(val) }
Note: This method is not used to check if the URL matches. It's used to check if a decoded value is this type. Use pattern to check the encoded value in the URL.
true if the value matches the type, otherwise false.
Generated using TypeDoc
An internal class which implements ParamTypeDefinition.
A ParamTypeDefinition is a plain javascript object used to register custom parameter types. When a param type definition is registered, an instance of this class is created internally.
This class has naive implementations for all the ParamTypeDefinition methods.
Used by UrlMatcher when matching or formatting URLs, or comparing and validating parameter values.
Example:
var paramTypeDef = { decode: function(val) { return parseInt(val, 10); }, encode: function(val) { return val && val.toString(); }, equals: function(a, b) { return this.is(a) && a === b; }, is: function(val) { return angular.isNumber(val) && isFinite(val) && val % 1 === 0; }, pattern: /\d+/ } var paramType = new ParamType(paramTypeDef);