Temporal.PlainTime.prototype.toLocaleString()

可用性有限

此特性不是基線特性,因為它在一些最廣泛使用的瀏覽器中不起作用。

實驗性: 這是一項實驗性技術
在生產中使用此技術之前,請仔細檢查瀏覽器相容性表格

toLocaleString() 方法是 Temporal.PlainTime 例項的一個方法,它返回一個根據語言習慣表示時間的字串。在支援 Intl.DateTimeFormat API 的實現中,此方法會委託給 Intl.DateTimeFormat

每次呼叫 toLocaleString 時,它都必須在一個龐大的本地化字串資料庫中進行搜尋,這可能會效率低下。當該方法以相同的引數多次呼叫時,最好建立一個 Intl.DateTimeFormat 物件並使用其 format() 方法,因為 DateTimeFormat 物件會記住傳遞給它的引數,並可能決定快取資料庫的一部分,因此未來的 format 呼叫可以在更受限制的上下文中搜索本地化字串。

語法

js
toLocaleString()
toLocaleString(locales)
toLocaleString(locales, options)

引數

localesoptions 引數自定義函式行為,並允許應用程式指定應使用的語言的格式約定。

在支援 Intl.DateTimeFormat API 的實現中,這些引數與 Intl.DateTimeFormat() 建構函式的引數完全對應。不支援 Intl.DateTimeFormat 的實現會返回與 toString() 完全相同的字串,並忽略這兩個引數。

locales 可選

一個帶有 BCP 47 語言標籤 的字串,或此類字串的陣列。對應於 Intl.DateTimeFormat() 建構函式的 locales 引數。

options 可選

一個調整輸出格式的物件。對應於 Intl.DateTimeFormat() 建構函式的 options 引數。關於 日期時間元件選項 和樣式快捷方式(dateStyletimeStyle),選項應遵循以下形式之一:

  • 不提供任何選項:hourminutesecond 將預設設定為 "numeric"
  • 僅提供 timeStyle:它將擴充套件到 dayPeriodhourminutesecondfractionalSecondDigits 格式。
  • 提供一些日期時間元件選項,其中至少有一個是時間選項(dayPeriodhourminutesecondfractionalSecondDigits)。輸出將僅包含指定的這些時間元件。

有關這些引數及其使用方法的詳細資訊,請參閱 Intl.DateTimeFormat() 建構函式

返回值

一個根據語言特定約定表示給定時間的字串。

在支援 Intl.DateTimeFormat 的實現中,這等同於 new Intl.DateTimeFormat(locales, options).format(time),其中 options 已按上述方式進行了規範化。

注意: 大多數情況下,toLocaleString() 返回的格式是一致的。然而,輸出在不同實現之間可能會有所不同,即使在相同的區域設定中也是如此——輸出差異是設計使然,並受規範允許。它也可能不符合您的預期。例如,字串可能使用不間斷空格或被雙向控制字元包圍。您不應將 toLocaleString() 的結果與硬編碼常量進行比較。

異常

RangeError

如果任何選項無效,則丟擲。

TypeError

如果任何選項的型別不符合預期,則丟擲。

示例

使用 toLocaleString()

不指定 locale 的此方法的簡單用法以預設區域設定和預設選項返回格式化字串。

js
const time = Temporal.PlainTime.from("12:34:56");

console.log(time.toLocaleString()); // 12:34:56 PM (assuming en-US locale)

使用帶選項的 toLocaleString()

您可以透過提供 options 引數來定製要包含在輸出中的時間的各個部分。

js
const time = Temporal.PlainTime.from("12:34:56");
time.toLocaleString("en-US", { timeStyle: "short" }); // 12:34 PM
time.toLocaleString("en-US", { hour: "2-digit" }); // 12 PM

規範

規範
Temporal
# sec-temporal.plaintime.prototype.tolocalestring

瀏覽器相容性

另見