requireRichTextValue

function requireRichTextValue(
  value: unknown,
  message: string = "Expected a RichTextValue object."
): GoogleAppsScript.Spreadsheet.RichTextValue;

У сервисного объекта Apps Script нет конструктора, с которым скрипт мог бы сравнить значение, поэтому проверка читает тег, который объект сообщает о себе сам: value.toString() === "RichTextValue". Обычный объект с таким же тегом тоже пройдёт — на практике это тестовый дубль.

isX и nonX отвечают на вопрос и никогда не прерывают выполнение; requireX и requireNonX возвращают значение или выбрасывают исключение. Схема разобрана в Соглашения о проверках.

Параметры

Параметр	Тип	Описание
`value`	`unknown`	Значение, которое нужно проверить.
`message` (необязательный) `= "Expected a RichTextValue object."`	`string`	Сообщение исключения. Если не задано, используется сообщение по умолчанию.

Возвращает

GoogleAppsScript.Spreadsheet.RichTextValue — то же значение, уже проверенное как форматированный текст.

Исключения

Исключение	Условие
`IllegalArgumentException`	значение не является форматированным текстом.

Примеры

Что проходит, а что нет

const value = SpreadsheetApp.newRichTextValue().setText("a").build();

requireRichTextValue(value); // => value
requireRichTextValue({}); // throws IllegalArgumentException
requireRichTextValue(null); // throws IllegalArgumentException

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

Исходный код

src/appsscript/sheet/requireRichTextValue.ts

23 September 2026

Эта документация сгенерирована нейросетью (Claude) на основе исходного кода библиотеки.