Intl.RelativeTimeFormat.prototype.format()

Метод format() экземпляров Intl.RelativeTimeFormat форматирует value и unit в соответствии с локалью и параметрами форматирования этого объекта Intl.RelativeTimeFormat.

Попробуйте

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

console.log(rtf.format(3, "quarter"));
// Expected output: "in 3 qtrs."

console.log(rtf.format(-1, "day"));
// Expected output: "1 day ago"

console.log(rtf.format(10, "seconds"));
// Expected output: "in 10 sec."

Синтаксис

format(value, unit)

Параметры

value

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

unit

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

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

Строка, представляющая данное value и unit, отформатированная в соответствии с локалью и параметрами форматирования этого объекта Intl.RelativeTimeFormat.

Примеры

Базовое использование format

Следующий пример показывает, как создать форматировщик относительного времени, используя английский язык.

// Create a relative time formatter in your locale
// with default values explicitly passed in.
const rtf = new Intl.RelativeTimeFormat("en", {
  localeMatcher: "best fit", // other values: "lookup"
  numeric: "always", // other values: "auto"
  style: "long", // other values: "short" or "narrow"
});

// Format relative time using negative value (-1).
rtf.format(-1, "day"); // "1 day ago"

// Format relative time using positive value (1).
rtf.format(1, "day"); // "in 1 day"

Использование опции auto

Если передана опция numeric: "auto", она будет генерировать строку yesterday, today или tomorrow вместо 1 day ago, in 0 days или in 1 day. Это позволяет избежать использования числовых значений в выводе.

// Create a relative time formatter in your locale
// with numeric: "auto" option value passed in.
const rtf = new Intl.RelativeTimeFormat("en", { numeric: "auto" });

// Format relative time using negative value (-1).
rtf.format(-1, "day"); // "yesterday"

rtf.format(0, "day"); // "today"

// Format relative time using positive day unit (1).
rtf.format(1, "day"); // "tomorrow"

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

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

См. также

• Intl.RelativeTimeFormat