Implemented by instances of NumberFormatter and DateFormatter.
Note however that a custom implementation need to be created by such a factory object; it only needs to implement the required properties.
Members
expectation :string
A string to use when no validation error message is available.
Implementation of this property is optional.
This string should describe the syntax and semantics of the expected value. Typically it begins with "Expected ..."
If undefined and in the absence of an error message, the user will know only that the value is invalid but nothing else.
Overridden by options.expectation passed to constructor.
Type:
- string
locale :string
Locale provided to constructor. Required.
Type:
- string
name :string
Name to use for registering the localizer.
Implementation of this property is optional. If undefined, a name will need to be supplied at registration time.
Type:
- string
Methods
format(value) → {string}
Transform a primitive value into a human-friendly string representation.
Implementation of this method is required.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
* |
Returns:
- Type
- string
invalid() → {boolean|string}
Tests string representation for invalidity.
Implementation of this method is optional.
The method may be strict or loose but caller has no way of knowing and must assume loose. Loose means it may return a false negative. This means that while a truthy return means invalid, falsy merely means "not invalid." In other words, you cannot assume that a falsy value means valid. The parser is the final arbiter and should be designed to throw an error on parser jam. For example, a number parser should not simply return NaN but should throw an error.
Overridden by options.invalid passed to constructor.
Returns:
Truthy value means invalid. If a string, this will be an error message. If not a string, it merely indicates a generic invalid result.
- Type
- boolean | string
parse(editedValue) → {null|*}
Transform a formatted string representation back into a primitive typed value.
Implementation of this method is required.
Parameters:
| Name | Type | Description |
|---|---|---|
editedValue |
string |
Throws:
-
Parser error.
- Type
- boolean | string | Error
Returns:
Primitive typed value.
- Type
- null | *