1. Web
  2. JavaScript
  3. Reference
  4. Standard built-in objects
  5. Temporal
  6. Temporal.PlainYearMonth
  7. toLocaleString()

Temporal.PlainYearMonth.prototype.toLocaleString()

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Phương thức toLocaleString() của các thực thể Temporal.PlainYearMonth trả về một chuỗi biểu diễn năm-tháng này theo ngôn ngữ cụ thể. Trong các triển khai có hỗ trợ API Intl.DateTimeFormat, phương thức này ủy quyền cho Intl.DateTimeFormat.

Mỗi lần toLocaleString được gọi, nó phải tìm kiếm trong một cơ sở dữ liệu lớn các chuỗi bản địa hóa, điều này có thể kém hiệu quả. Khi phương thức được gọi nhiều lần với cùng đối số, tốt hơn là tạo một đối tượng Intl.DateTimeFormat và sử dụng phương thức format() của nó, vì đối tượng DateTimeFormat ghi nhớ các đối số được truyền vào và có thể quyết định lưu vào bộ nhớ đệm một phần cơ sở dữ liệu, do đó các lần gọi format trong tương lai có thể tìm kiếm chuỗi bản địa hóa trong ngữ cảnh bị hạn chế hơn.

Cú pháp

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

Tham số

Các tham số locales và options tùy chỉnh hành vi của hàm và cho phép ứng dụng chỉ định ngôn ngữ có quy ước định dạng sẽ được sử dụng.

Trong các triển khai có hỗ trợ API Intl.DateTimeFormat, các tham số này tương ứng chính xác với các tham số của constructor Intl.DateTimeFormat(). Các triển khai không có hỗ trợ Intl.DateTimeFormat trả về cùng chuỗi như toString(), bỏ qua cả hai tham số.

locales Optional

Một chuỗi có BCP 47 language tag, hoặc một mảng các chuỗi như vậy. Tương ứng với tham số locales của constructor Intl.DateTimeFormat().

options Optional

Một đối tượng điều chỉnh định dạng đầu ra. Tương ứng với tham số options của constructor Intl.DateTimeFormat(). Tùy chọn calendar phải được cung cấp với cùng giá trị như lịch của năm-tháng này. Về các tùy chọn thành phần ngày-giờ và các phím tắt kiểu (dateStyle và timeStyle), các tùy chọn nên tuân theo một trong các dạng sau:

  • Không cung cấp tùy chọn nào: year và month sẽ mặc định là "numeric".
  • Chỉ cung cấp dateStyle: nó sẽ mở rộng sang các định dạng era, year, và month.
  • Cung cấp một số tùy chọn thành phần ngày-giờ, trong đó ít nhất một trong số đó là year hoặc month. Chỉ các thành phần ngày được chỉ định sẽ được đưa vào đầu ra.

Xem constructor Intl.DateTimeFormat() để biết chi tiết về các tham số này và cách sử dụng chúng.

Giá trị trả về

Một chuỗi đại diện cho năm-tháng đã cho theo các quy ước ngôn ngữ cụ thể.

Trong các triển khai có Intl.DateTimeFormat, điều này tương đương với new Intl.DateTimeFormat(locales, options).format(yearMonth), trong đó options đã được chuẩn hóa như mô tả ở trên.

Note: Hầu hết thời gian, định dạng được trả về bởi toLocaleString() là nhất quán. Tuy nhiên, đầu ra có thể khác nhau giữa các triển khai, ngay cả trong cùng một locale — sự biến đổi đầu ra là theo thiết kế và được phép bởi đặc tả. Nó cũng có thể không như bạn mong đợi. Ví dụ, chuỗi có thể sử dụng khoảng trắng không ngắt hoặc được bao quanh bởi các ký tự kiểm soát hai chiều. Bạn không nên so sánh kết quả của toLocaleString() với các hằng số được mã hóa cứng.

Ngoại lệ

RangeError

Ném ra nếu bất kỳ tùy chọn nào không hợp lệ.

TypeError

Ném ra nếu bất kỳ tùy chọn nào không thuộc kiểu dự kiến.

Ví dụ

Sử dụng toLocaleString()

Sử dụng cơ bản phương thức này mà không chỉ định locale sẽ trả về một chuỗi được định dạng theo locale mặc định và với các tùy chọn mặc định.

js
// Lưu ý rằng chỉ chỉ định "2021-08" mặc định là lịch ISO 8601,
// điều này ném ra lỗi nếu lịch mặc định của locale không phải là ISO 8601.
const ym = Temporal.PlainYearMonth.from("2021-08-01[u-ca=gregory]");

console.log(ym.toLocaleString()); // 8/2021 (giả sử locale en-US và lịch Gregorian)

Nếu lịch của năm-tháng không khớp với lịch mặc định của locale, ngay cả khi lịch của nó là iso8601, phải cung cấp tùy chọn calendar tường minh với cùng giá trị.

js
const ym = Temporal.PlainYearMonth.from("2021-08");
ym.toLocaleString("en-US", { calendar: "iso8601" }); // 2021-08

Sử dụng toLocaleString() với các tùy chọn

Bạn có thể tùy chỉnh các phần nào của năm-tháng được đưa vào đầu ra bằng cách cung cấp tham số options.

js
const ym = Temporal.PlainYearMonth.from("2021-08-01[u-ca=gregory]");
ym.toLocaleString("en-US", { dateStyle: "full" }); // August 2021
ym.toLocaleString("en-US", { year: "2-digit" }); // 21
ym.toLocaleString("en-US", { month: "long" }); // August

Đặc tả

Specification
Temporal
# sec-temporal.plainyearmonth.prototype.tolocalestring

Tương thích trình duyệt

Xem thêm

Help improve MDN

Learn how to contribute

This page was last modified on by MDN contributors.

View this page on GitHub • Report a problem with this content