requireSymbol

function requireSymbol(value: unknown, message: string = "Expected a symbol."): symbol;

Подходят и символы из Symbol.for, и общеизвестные символы; больше ничего.

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

Параметры

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

Возвращает

symbol — то же значение, уже проверенное как символ.

Исключения

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

Примеры

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

requireSymbol(Symbol("id")); // => Symbol("id")
requireSymbol(Symbol.iterator); // => Symbol.iterator
requireSymbol("id"); // throws IllegalArgumentException
requireSymbol(null); // throws IllegalArgumentException

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

Исходный код

src/lang/base/requireSymbol.ts

23 September 2026

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