isKeyof

La méthode isKeyof() vérifie si une clé existe dans un objet et affine le type de la clé en conséquence.

Exemple interactif

Syntaxe

Signature classique

function isKeyof<
	GenericObject extends object,
	GenericKey extends ObjectKey
>(
	key: GenericKey,
	obj: GenericObject
): key is keyof GenericObject & GenericKey

Signature currifiée

function isKeyof<
	GenericObject extends object,
	GenericKey extends ObjectKey
>(
	obj: GenericObject
): (key: GenericKey) => key is keyof GenericObject & GenericKey

Paramètres

• key : La clé à vérifier (string, number ou symbol).
• obj : L'objet dans lequel vérifier l'existence de la clé.

Valeur de retour

Un booléen indiquant si la clé existe dans l'objet. Le type de retour utilise une assertion de type conditionnelle pour affiner le type de key si la condition est vraie.

Voir aussi

• includes - Vérifie si une sous-chaîne est présente
• startsWith - Vérifie si une chaîne commence par une sous-chaîne
• endsWith - Vérifie si une chaîne se termine par une sous-chaîne

Sources

• TypeScript - Type Guards - Documentation sur les type guards