Array of valid plural categories for the current locale, used to validate plural keys.
If undefined, the full set of valid PluralCategory keys is used. To disable this check, pass in an empty array.
Toggles CDATA sections recognition <![CDATA[ … ]]>. If set to false then CDATA sections are treated as
comments.
The list of file paths included in the compilation.
Array of valid plural categories for the current locale, used to validate selectordinal keys.
If undefined, the full set of valid PluralCategory keys is used. To disable this check, pass in an empty array.
The key that is used as the default for select.
The output folder for all emitted files.
The configuration presets that must be used as a fallback.
Toggles processing instructions recognition <?xml-stylesheet … ?>. If set to false then processing
instructions are treated as comments.
The root folder from which include are resolved.
The path from which runtime dependencies are imported.
Toggles self-closing tags recognition <foo/>. If set to false then slash in self closing tags is ignored or
processed as a part of an attribute value, depending on the markup.
By default, the parsing applies a few relaxations to the ICU MessageFormat spec.
Setting strict: true will disable these relaxations.
If set to true then TypeScript interfaces and function types are rendered.
Checks whether the content of the container tag should be interpreted as a markup or as a character data. Entities
aren't decoded in the content of character data tags. Useful when parsing such tags as script, style and
others.
The start tag token read from the source.
true to interpret the contents of the token container tag as a character data, false otherwise.
Checks whether the tag has no content. Useful when parsing such tags as hr, img and others.
The start tag token.
true to interpret tag as self-closing even if it isn't marked up as such, false otherwise.
Decodes XML entities in an attribute value. If omitted then decodeText callback is used.
The attribute value to decode.
The decoded value.
Decodes XML entities in a plain text value.
The text to decode.
The decoded text.
Inspects ancestors and returns an index of an ancestor for which end tag is implied. Useful when parsing such tags
as p, li, td and others.
The list of start tag tokens of current ancestors.
The token of the start tag that was read.
The index among ancestors that points to an ancestor for which an end tag is implied or -1 if no
implicit end detected.
Returns the doc comment rendered.
Triggered if an error occurred while compiling a message. If omitted then an error is thrown.
Returns the default locale for a message. If omitted then the first locale from message.translations is used as
default.
Returns the TypeScript type of the argument that a function expects. If omitted then arguments of all functions
are typed as unknown.
The name of the function.
Rewrites argument name.
The name of an argument.
The new name of an argument.
Rewrites an attribute name.
The raw name of the attribute.
The rewritten name of the attribute.
Rewrites formatting function name.
The name of a function.
The new name of a function.
Returns an arguments interface name.
Returns a message rendering function name.
Rewrites a tag name. Start and end tags are matched via tag name comparison. Provide a rewriter to support case-insensitive tag matching.
The raw name of the tag.
The rewritten name of the tag.
Returns arbitrary source code that is rendered after message function rendering is completed.
Receives a message translation and returns a new translation.
Use this to apply preprocessors (such as markdown-to-HTML) or typography re-writers.
The text of the translation.
The translation locale.
Transforms a translation node before it is compiled.
The node that represents the parsed translation.
The translation locale.
The name of the message.
The message that contains the translation.
The transformed node. If undefined is returned then node would be used for compilation.
Generated using TypeDoc
The compilation adapter that should be used or a path from which adapter should be loaded.