Intl.RelativeTimeFormat.prototype.formatToParts()

Метод formatToParts() экземпляров Intl.RelativeTimeFormat возвращает массив объектов, представляющих каждую часть отформатированной строки, которая была бы возвращена методом format(). Он полезен для создания пользовательских строк из локализованных токенов.

Попробуйте

const rtf = new Intl.RelativeTimeFormat("en", { numeric: "auto" });
const parts = rtf.formatToParts(10, "seconds");

console.log(parts[0].value);
// Expected output: "in "

console.log(parts[1].value);
// Expected output: "10"

console.log(parts[2].value);
// Expected output: " seconds"

Синтаксис

formatToParts(value, unit)

Параметры

value

Числовое значение для использования в интернационализированном сообщении относительного времени.

unit

Единица измерения для использования в интернационализированном сообщении относительного времени. Возможные значения: "year", "quarter", "month", "week", "day", "hour", "minute", "second". Разрешены также множественные формы.

Возвращаемое значение

Array объектов, содержащих отформатированное относительное время по частям. Каждый объект имеет два или три свойства: type, value и, опционально, unit, каждое из которых содержит строку. Конкатенация строк value в указанном порядке даст ту же строку, что и format(). Части можно рассматривать как полученные непосредственно путем вызова Intl.NumberFormat.prototype.formatToParts() с числовым значением, передавая только опцию numberingSystem, а затем добавляя дополнительные токены type: "literal", такие как "in ", " days ago" и т.д. Все токены, производимые NumberFormat, имеют дополнительное свойство unit, которое является единственной формой входного unit; это для программного использования и не локализовано. Локализованная единица измерения выводится как часть литерального токена.

Когда options.numeric равно "auto", и для значения существует специальная строка, возвращаемый массив представляет собой один литеральный токен.

Примеры

Использование formatToParts()

const rtf = new Intl.RelativeTimeFormat("en", { numeric: "auto" });

// Format relative time using the day unit
rtf.formatToParts(-1, "day");
// [{ type: "literal", value: "yesterday"}]

rtf.formatToParts(100, "day");
// [
//   { type: "literal", value: "in " },
//   { type: "integer", value: "100", unit: "day" },
//   { type: "literal", value: " days" }
// ]

Спецификации

Совместимость с браузерами

См. также

• Intl.RelativeTimeFormat
• Intl.RelativeTimeFormat.prototype.format()