requireSymbol

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

Les symboles enregistrés par Symbol.for et les symboles bien connus passent tous deux ; rien d'autre.

isX et nonX répondent à une question sans jamais interrompre le flot ; requireX et requireNonX rendent la valeur ou lèvent. Le schéma est expliqué dans Conventions de validation.

Paramètres

Paramètre	Type	Description
`value`	`unknown`	La valeur à valider.
`message` (facultatif) `= "Expected a symbol."`	`string`	Le message de l'exception. À défaut, un message par défaut est utilisé.

Valeur de retour

symbol — la même valeur, typée comme un symbole.

Exceptions

Exception	Condition
`IllegalArgumentException`	la valeur n'est pas un symbole.

Exemples

Ce qui passe et ce qui ne passe pas

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

Voir aussi

Code source

src/lang/base/requireSymbol.ts

23 September 2026

Cette documentation a été générée par une IA (Claude) à partir du code source de la bibliothèque.