toPairs

INFO

This function is only available in es-toolkit/compat for compatibility reasons. It either has alternative native JavaScript APIs or isn’t fully optimized yet.

When imported from es-toolkit/compat, it behaves exactly like lodash and provides the same functionalities, as detailed here.

Creates an array of key-value pairs from an object, set, or map.

• When an object is provided, it returns an array of elements paired with the object's properties and values ([key, value]).
• When a Set is provided, it returns an array of elements paired in the format [value, value].
• When a Map is provided, it returns an array of elements paired with keys and values ([key, value]).

Signature

function toPairs<T>(object: Record<string | number, T>): Array<[string, T]>;
function toPairs<T>(set: Set<T>): Array<[T, T]>;
function toPairs<K, V>(map: Map<K, V>): Array<[K, V]>;

Parameters

• object (Record<string | number, T> | Set<T> | Map<K, V>): The object, Set, or Map to query.

Returns

(Array<[key: PropertyKey, value: T]>): Array of property-value pairs.

Examples

const object = { a: 1, b: 2 };
toPairs(object); // [['a', 1], ['b', 2]]

const set = new Set([1, 2]);
toPairs(set); // [[1, 1], [2, 2]]

const map = new Map();
map.set('a', 1);
map.set('b', 2);
toPairs(map); // [['a', 1], ['b', 2]]