If not defined, default and initial locale is the first entry of locales
Example
// build.jsimport fs from 'fs';import MessageFormat from 'messageformat';const mf = new MessageFormat(['en', 'fi']);const msgSet = { en: { a: 'A {TYPE} example.', b: 'This has {COUNT, plural, one{one user} other{# users}}.', c: { d: 'We have {P, number, percent} code coverage.' } }, fi: { b: 'Tällä on {COUNT, plural, one{yksi käyttäjä} other{# käyttäjää}}.', e: 'Minä puhun vain suomea.' }};fs.writeFileSync('messages.js'
// runtime.jsimport Messages from 'messageformat-runtime/messages';import msgData from './messages';const messages = new Messages(msgData, 'en');messages.hasMessage('a') // truemessages.hasObject('c') // truemessages.get('b', { COUNT: 3 }) // 'This has 3 users.'messages.get(['c', 'd'], { P: 0.314 }) // 'We have 31% code coverage.'messages.get('e') // 'e'messages.
module.exports.availableLocales : Array.<string>
List of available locales
Kind: instance property of module.exports Read only: true
module.exports.locale : string | null
Current locale
One of Messages#availableLocales or null. Partial matches of language tags
are supported, so e.g. with an en locale defined, it will be selected by
messages.locale = 'en-US' and vice versa.
One of Messages#availableLocales or null. Partial matches of language tags
are supported, so e.g. with an en locale defined, it will be selected by
messages.defaultLocale = 'en-US' and vice versa.
Add new messages to the accessor; useful if loading data dynamically
The locale code lc should be an exact match for the locale being updated,
or empty to default to the current locale. Use #resolveLocale for
resolving partial locale strings.
If keypath is empty, adds or sets the complete message object for the
corresponding locale. If any keys in keypath do not exist, a new object
will be created at that key.
Kind: instance method of module.exports Returns: Messages - The Messages instance, to allow for chaining
Param
Type
Description
data
function | object
Hierarchical map of keys to functions, or a single message function
[lc]
string
If empty or undefined, defaults to this.locale
[keypath]
Array.<string>
The keypath being added
module.exports.resolveLocale(lc) ⇒ string | null
Resolve lc to the key of an available locale or null, allowing for
partial matches. For example, with an en locale defined, it will be
selected by messages.defaultLocale = 'en-US' and vice versa.
key may be a string for functions at the root level, or string[] for
accessing hierarchical objects. If an exact match is not found and fallback
is true, the fallback locales are checked for the first match.
key may be a string for functions at the root level, or string[] for
accessing hierarchical objects. If an exact match is not found and fallback
is true, the fallback locales are checked for the first match.
key may be a string for functions at the root level, or string[] for
accessing hierarchical objects. If an exact match is not found, the fallback
locales are checked for the first match.
If key maps to a message function, it will be called with props. If it
maps to an object, the object is returned directly.