flat

function flat(source: object, depth: number = Infinity): Record<string, unknown>;

Les objets imbriqués deviennent des chemins pointés ; les tableaux restent entiers, car leurs indices sont des données et non de la structure. depth arrête la descente — 1 n'aplatit que le premier niveau.

Le chemin inverse est getPath, qui relit une valeur par le même type de chemin.

Paramètres

Paramètre	Type	Description
`source`	`object`	L'objet à aplatir. Ce ne doit pas être un tableau.
`depth` (facultatif) `= Infinity`	`number`	Combien de niveaux descendre. Un entier ; illimité par défaut.

Valeur de retour

Record<string, unknown> — un nouvel objet plat dont les clés sont des chemins pointés.

Exceptions

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

Exemples

Aplatissement

flat({ a: { b: 1 }, c: [1, 2] }); // => { "a.b": 1, "c": [1, 2] }
flat({ a: { b: { c: 1 } } }, 1); // => { "a.b": { "c": 1 } }

Voir aussi

Code source

src/lang/object/flat.ts

23 September 2026

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