group

La fonction group() regroupe les éléments d'un itérable dans un objet de tableaux à partir du nom de groupe renvoyé par votre callback.

Exemple interactif

Syntaxe

Signature classique

function group<
	GenericElement extends unknown,
	GenericOutput extends GroupFunctionOutput,
>(
	iterator: Iterable<GenericElement>,
	theFunction: (
		element: GenericElement,
		params: GroupFunctionParams
	) => GenericOutput,
): GroupResult<GenericOutput>

Signature currifiée

function group<
	GenericElement extends unknown,
	GenericOutput extends GroupFunctionOutput,
>(
	theFunction: (
		element: GenericElement,
		params: GroupFunctionParams
	) => GenericOutput,
): (iterator: Iterable<GenericElement>) => GroupResult<GenericOutput>

Paramètres

• iterator : Source itérable à regrouper.
• theFunction : Fonction de regroupement qui reçoit :
• element : Élément courant.
• params.index : Index courant.
• params.output(group, value) : Helper pour construire une sortie de groupe typée.

Valeur de retour

Un objet où chaque clé est un nom de groupe et chaque valeur un tableau de valeurs regroupées. Les clés sont optionnelles car un groupe peut être absent du résultat final.

Voir aussi

• asyncGroup - Version asynchrone de group
• reduce - Réduit un générateur en une valeur unique