minElements

La fonction minElements() vérifie qu'un tableau contient au moins un nombre donné d'éléments. Elle agit comme un type guard, ce qui permet à TypeScript d'inférer un tuple d'au minimum minLength éléments.

Exemple interactif

Syntaxe

Signature classique

function minElements<
	GenericInput extends readonly unknown[],
	GenericLength extends number
>(
	input: GenericInput,
	minLength: GenericLength
): input is [
	...CreateTuple<GenericInput[number], GenericLength>,
	...GenericInput[number][]
]

Signature currifiée

function minElements<
	GenericInput extends readonly unknown[],
	GenericLength extends number
>(
	minLength: GenericLength
): (
	input: GenericInput
) => input is [
	...CreateTuple<GenericInput[number], GenericLength>,
	...GenericInput[number][]
]

Paramètres

• input : Tableau dont on souhaite garantir un nombre minimal d'éléments.
• minLength : Nombre minimum attendu.

Valeur de retour

true si la longueur du tableau est supérieure ou égale à minLength, sinon false. Lorsque la fonction retourne true, le type du tableau est affiné afin de refléter la contrainte.

Voir aussi

• maxElements - Impose un nombre maximal d'éléments
• length - Retourne la taille exacte d'un tableau

Sources

• MDN Web Docs - Array.length