find

La méthode find() retourne le premier élément d'un tableau qui satisfait une condition donnée.

Exemple interactif

Syntaxe

Signature classique

// Type Guard
function find<
	GenericInput extends readonly unknown[],
	GenericOutput extends GenericInput[number]
>(
	input: GenericInput, 
	predicate: (
		element: GenericInput[number], 
		params: ArrayFindParams
	) => element is GenericOutput
): GenericOutput | undefined

// Boolean
function find<
	GenericInput extends readonly unknown[]
>(
	input: GenericInput, 
	predicate: (
		element: GenericInput[number], 
		params: ArrayFindParams
	) => boolean
): GenericInput[number] | undefined

Signature currifiée

// Type Guard
function find<
	GenericInput extends readonly unknown[],
	GenericOutput extends GenericInput[number]
>(
	predicate: (
		element: GenericInput[number], 
		params: ArrayFindParams
	) => element is GenericOutput
): (input: GenericInput) => GenericOutput | undefined

// Boolean
function find<
	GenericInput extends readonly unknown[]
>(
	predicate: (
		element: GenericInput[number], 
		params: ArrayFindParams
	) => boolean
): (input: GenericInput) => GenericInput[number] | undefined

Paramètres auxiliaires

interface ArrayFindParams {
	index: number;
}

Paramètres

• input : Le tableau dans lequel rechercher.
• predicate : Fonction de prédicat qui teste chaque élément (et peut servir de type guard). Reçoit l'élément et un objet contenant l'index.
• params.index : Position de l'élément en cours dans le tableau.

Valeur de retour

Le premier élément qui satisfait la condition, ou undefined si aucun élément ne correspond.

Voir aussi

• findLast - Trouve le dernier élément qui satisfait une condition
• findIndex - Retourne l'index au lieu de l'élément

Sources

• MDN Web Docs - Array.find()