DateFormatter getLocaleString

getLocaleString

DateFormatter - getLocaleString

Description

string getLocaleString()

This function returns a string representing the locale settings object.

Parameters

This function doesn't use any parameters.

Return value

A string representation of the locale settings object. If no locale settings are defined null will be returned. If you want to know more about the structure of the locale settings object see setLocaleSettings.

Errors/Exceptions

This function doesn't throw any exception.

Examples

var dateFormatter = new DateFormatter();
dateFormatter.setLocaleSettings({ampm: ['am', 'pm']});
console.log(dateFormatter.getLocaleString());

This will lead to the following output:

{ampm:['am','pm']}