Temporal.PlainYearMonth.prototype.toString()

Метод toString() экземпляров Temporal.PlainYearMonth возвращает строку, представляющую этот год-месяц в формате RFC 9557.

Синтаксис

toString()
toString(options)

Параметры

options Необязательно

Объект, содержащий следующее свойство:

calendarName Необязательно

Следует ли показывать аннотацию календаря ([u-ca=calendar_id]) в возвращаемом значении. Возможные значения:

"auto" (по умолчанию)

Включает аннотацию календаря, если календарь не "iso8601". Опорный день включается, если календарь не "iso8601".

"always"

Всегда включать аннотацию календаря. Опорный день также всегда включается.

"never"

Никогда не включать аннотацию календаря. Это делает возвращаемую строку невосстановимой до того же экземпляра Temporal.PlainYearMonth, хотя значение год-месяц остается прежним. Опорный день включается, если календарь не "iso8601".

"critical"

Всегда включать аннотацию календаря и добавлять критический флаг: [!u-ca=calendar_id]. Полезно при отправке строки в определенные системы, но не полезно для самого Temporal. Опорный день также всегда включается.

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

Строка в формате RFC 9557, представляющая этот год-месяц. Аннотация календаря включается в соответствии с указанием. Опорный день включается, если включена аннотация календаря или если календарь не "iso8601".

Исключения

RangeError

Выбрасывается, если какой-либо из параметров недействителен.

TypeError

Выбрасывается, если options не является объектом или undefined.

Примеры

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

const ym = Temporal.PlainYearMonth.from({ year: 2021, month: 8 });
console.log(ym.toString()); // '2021-08'

const ym2 = Temporal.PlainYearMonth.from({
  year: 5781,
  monthCode: "M08",
  calendar: "hebrew",
});
console.log(ym2.toString()); // '2021-04-13[u-ca=hebrew]'

Использование параметров

const isoYM = Temporal.PlainYearMonth.from({ year: 2021, month: 8 });
const ym = Temporal.PlainYearMonth.from({
  year: 5781,
  monthCode: "M08",
  calendar: "hebrew",
});
console.log(isoYM.toString({ calendarName: "auto" })); // '2021-08'
console.log(ym.toString({ calendarName: "auto" })); // '2021-04-13[u-ca=hebrew]'
console.log(isoYM.toString({ calendarName: "always" })); // '2021-08-01[u-ca=iso8601]'
console.log(ym.toString({ calendarName: "always" })); // '2021-04-13[u-ca=hebrew]'
console.log(isoYM.toString({ calendarName: "never" })); // '2021-08'
console.log(ym.toString({ calendarName: "never" })); // '2021-04-13'
console.log(isoYM.toString({ calendarName: "critical" })); // '2021-08-01[!u-ca=iso8601]'
console.log(ym.toString({ calendarName: "critical" })); // '2021-04-13[!u-ca=hebrew]'

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

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

Смотрите также

• Temporal.PlainYearMonth
• Temporal.PlainYearMonth.from()
• Temporal.PlainYearMonth.prototype.toJSON()
• Temporal.PlainYearMonth.prototype.toLocaleString()