flatten-anything/dist/index.d.ts

Flatten objects and replace nested props with 'prop.subprop'. A simple and small integration

/**
 * Flattens an object from `{a: {b: {c: 'd'}}}` to `{'a.b.c': 'd'}`
 *
 * @export
 * @param object the object to flatten
 * @param [number] how deep you want to flatten. 1 for flattening only the first nested prop, and keeping deeper objects as is.
 * @returns the flattened object
 */
export declare function flattenObject(object: {
    [key in string]: any;
}, untilDepth?: number): {
    [key in string]: any;
};
/**
 * Flattens an array from `[1, ['a', ['z']], 2]` to `[1, 'a', 'z', 2]`
 *
 * @export
 * @param array the array to flatten
 * @returns the flattened array
 */
export declare function flattenArray(array: any[]): any[];
/**
 * Flattens certain props of an object.
 *
 * @export
 * @param object the object to flatten Eg. `{a: {subA: 1}, b: {subB: 1}}`
 * @param [props=[]] the prop names you want to flatten. Eg. `['a']` will return `{'a.subA': 1, b: {subB: 1}}`
 * @returns the flattened object
 */
export declare function flattenObjectProps(object: {
    [key in string]: any;
}, props?: string[]): {
    [key in string]: any;
};
/**
 * Flattens an object or array.
 * Object example: `{a: {b: {c: 'd'}}}` to `{'a.b.c': 'd'}`
 * Array example: `[1, ['a', ['z']], 2]` to `[1, 'a', 'z', 2]`
 *
 * @export
 * @param objectOrArray the payload to flatten
 * @param [number] how deep you want to flatten. (currently only works with objects) 1 for flattening only the first nested prop, and keeping deeper objects as is.
 * @returns the flattened result
 */
export declare function flatten(objectOrArray: {
    [key in string]: any;
} | any[], untilDepth?: number): {
    [key in string]: any;
} | any[];