Intl.RelativeTimeFormat.prototype.formatToParts()

試してみましょう

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

console.log(parts[0].value);
// 予想される結果: "10"

console.log(parts[1].value);
// 予想される結果: " 秒後"

構文

formatToParts(value, unit)

引数

value

国際化対応の相対時間メッセージで使用する値です。

unit

国際化対応の相対時間のメッセージに使用する単位です。利用可能な値は、"year", "quarter", "month", "week", "day", "hour", "minute", "second" です。複数形も許容されています。

返値

書式化された相対時間を成分ごとに格納したオブジェクトの配列 (Array) です。各オブジェクトには、type、value、およびオプションで unit という 2 つまたは 3 つのプロパティがあり、それぞれに文字列が含まれています。value の文字列連結は、指定された順序で実行されると、format() と同じ文字列になります。各成分は、数値を引数として Intl.NumberFormat.prototype.formatToParts() を呼び出し、numberingSystem オプションのみを指定して取得し、さらに "in " や " days ago" などの追加の type: "literal" トークンを付加したものと考えることができます。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()