Interface: Converter

Oracle® JavaScript Extension Toolkit (JET)
8.0.0
F18189-01

Signature:

interface Converter<V>

QuickNav

Methods


Converter

Version:
  • 8.0.0
Since:
  • 0.6.0
Module:
  • ojconverter

Module usage

See JET Module Loading for an overview of module usage within JET.

Typescript Import Format
//To use this interface, import as below.
import {Converter} from "ojs/ojconverter";
Generic Parameters
ParameterDescription
VType of value to be converted. Parse will convert string to this type and format will format this type to string

JET In Typescript

A detailed description of working with JET elements and classes in your typescript project can be found at: JET Typescript Usage.

Constructs an immutable instance of Converter.

Methods

format(value) : {string|null}

Formats the value using the options provided.
Parameters:
Name Type Description
value V the value to be formatted for display
Throws:
if formatting fails.
Type
Error
Returns:
the localized and formatted value suitable for display
Type
string | null

getHint(): string|null

Returns a hint that describes the converter format expected.
Returns:
a hint describing the format the value is expected to be in.
Type
string | null

getOptions(): object

Returns the options called with converter initialization.
Returns:
an object of options.
Type
Object

parse(value) : {(V|null)}

Parses a String value using the options provided.
Parameters:
Name Type Description
value string to parse
Throws:
if parsing fails
Type
Error
Returns:
the parsed value.
Type
(V|null)

resolvedOptions(): object

Returns an object literal with locale and formatting options computed during initialization of the object. If options was not provided at the time of initialization, the properties will be derived from the locale defaults.
Returns:
an object of resolved options.
Type
Object