Covert complex javascript object into a one level object with dotted keys

dot-object.ts

interface DotObjectOptions {
    ignoreArrays?: boolean
}

export const dotObject = (object: Record<string, unknown>, options: DotObjectOptions = {}) => {

    if (!object || typeof object !== 'object') {
        throw Error('Not a object');
    }

    const { ignoreArrays } = options;
    const dottedObject = {};

    Object
        .keys(object)
        .forEach(key => {

            const value = object[key];

            if (!value || typeof value !== 'object' || (ignoreArrays && Array.isArray(value))) {
                dottedObject[key] = value;
                return;
            }

            const subObject = dotObject(value as Record<string, unknown>);

            Object
                .keys(subObject)
                .forEach(subKey => {
                    dottedObject[`${key}.${subKey}`] = subObject[subKey];
                });

        });

    return dottedObject;

};

example.md

const dottedObject = dotObject({
    name: 'homer',
    age: 39,
    address: {
        country: 'united states',
        city: 'springfield',
    },
    parents: [
        { id: 5, name: 'lisa' },
        { id: 8, name: 'meggie' }
    ],
    pets: ['santa claus little helper', 'snowball']
});

/* Output
{
    'name': 'homer',
    'age': 39,
    'address.country': 'united states',
    'address.city': 'springfield',
    'parents.0.id': 5,
    'parents.0.name': 'lisa',
    'parents.1.id': 8,
    'parents.1.name': 'meggie',
    'pets.0': 'santa claus little helper',
    'pets.1': 'snowball'',
}*/