source: node_modules/es-toolkit/dist/object/flattenObject.d.ts@ a762898

Last change on this file since a762898 was a762898, checked in by istevanoska <ilinastevanoska@…>, 5 months ago

Added visualizations

  • Property mode set to 100644
File size: 851 bytes
Line 
1interface FlattenObjectOptions {
2 /**
3 * The delimiter to use between nested keys.
4 * @default '.'
5 */
6 delimiter?: string;
7}
8/**
9 * Flattens a nested object into a single level object with delimiter-separated keys.
10 *
11 * @param {object} object - The object to flatten.
12 * @param {string} [options.delimiter='.'] - The delimiter to use between nested keys.
13 * @returns {Record<string, any>} - The flattened object.
14 *
15 * @example
16 * const nestedObject = {
17 * a: {
18 * b: {
19 * c: 1
20 * }
21 * },
22 * d: [2, 3]
23 * };
24 *
25 * const flattened = flattenObject(nestedObject);
26 * console.log(flattened);
27 * // Output:
28 * // {
29 * // 'a.b.c': 1,
30 * // 'd.0': 2,
31 * // 'd.1': 3
32 * // }
33 */
34declare function flattenObject(object: object, { delimiter }?: FlattenObjectOptions): Record<string, any>;
35
36export { flattenObject };
Note: See TracBrowser for help on using the repository browser.