PhraseyTranslation String Formats
Translation string formats transform the parsed translation string into desirable output string. They implement a formatter (converts PhraseyTranslationStringParts to any serializable object).
Representation
interface PhraseyTranslationStringFormatter<T = any> {
format(
parts: PhraseyTranslationStringParts,
schema: PhraseyZSchemaKeyType,
): T;
}interface PhraseyTranslationStringFormatter<T = any> {
format(
parts: PhraseyTranslationStringParts,
schema: PhraseyZSchemaKeyType,
): T;
}Example
import type { PhraseyTranslationStringFormatter } from "phrasey";
export const stringFormatter: PhraseyTranslationStringFormatter<string> = {
format: (parts) => {
let out = "";
parts.forEach((x) => {
switch (x.type) {
case "string":
out += this.escapeCharacter(x.value, "{");
break;
case "parameter":
out += `{${x.value}}`;
break;
}
});
return out;
},
};import type { PhraseyTranslationStringFormatter } from "phrasey";
export const stringFormatter: PhraseyTranslationStringFormatter<string> = {
format: (parts) => {
let out = "";
parts.forEach((x) => {
switch (x.type) {
case "string":
out += this.escapeCharacter(x.value, "{");
break;
case "parameter":
out += `{${x.value}}`;
break;
}
});
return out;
},
};Pre-existing Formats
Phrasey has built-in support for the below formats.
parts
Serializes the parsed string as it is.
Example of output string:
[
{ "type": "string", "value": "Hello, " },
{ "type": "parameter", "value": "user" },
{ "type": "string", "value": "!" }
][
{ "type": "string", "value": "Hello, " },
{ "type": "parameter", "value": "user" },
{ "type": "string", "value": "!" }
]compact-parts
Serializes the parsed string as compact parts. Here, 0 denotes a string and 1 denotes a parameter.
Example of output string:
[
[0, "Hello, "],
[1, "user"],
[0, "!"]
][
[0, "Hello, "],
[1, "user"],
[0, "!"]
]format-string
Serializes the parsed string as to a equivalent of printf() supported string. The output string uses positional argument with %s.
Example of output string:
Hello, %0$s!Hello, %0$s!java-format-string
Serializes the parsed string to be suitable for Java's .format() method. The output string uses positional argument with %s.
Example of output string:
Hello, %1$s!Hello, %1$s!python-format-string
Serializes the parsed string as to a equivalent of Python's .format() supported string.
Example of output string:
Hello, {user}!Hello, {user}!