flat

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

Verschachtelte Objekte werden zu Punktpfaden; Arrays bleiben ganz, denn ihre Indizes sind Daten, keine Struktur. depth beendet den Abstieg — 1 flacht nur die erste Ebene ab.

Der umgekehrte Weg ist getPath, das einen Wert über denselben Pfadtyp wieder ausliest.

Parameter

Parameter	Typ	Beschreibung
`source`	`object`	Das abzuflachende Objekt. Es darf kein Array sein.
`depth` (optional) `= Infinity`	`number`	Wie viele Ebenen abgestiegen wird. Eine ganze Zahl; standardmäßig unbegrenzt.

Rückgabewert

Record<string, unknown> — ein neues flaches Objekt mit Punktpfaden als Schlüsseln.

Ausnahmen

Ausnahme	Bedingung
`IllegalArgumentException`	der Wert ist kein Objekt.

Beispiele

Abflachen

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

Siehe auch

Quellcode

src/lang/object/flat.ts

23 September 2026

Diese Dokumentation wurde mit KI (Claude) aus dem Quellcode der Bibliothek erzeugt.