getValueFromPath

getValueFromPath.ts

/**
 * Retrive the specific value from an object, given the property path separated by a splitter.
 * The generic defines the expected return type.
 * Beware that, for example, defining a generic "string" won't assure us
 * that the value from the object will have the same type. We are "trusting" the object.
 *
 * @param object
 * @param path
 * @param splitter
 */
export default <T>(
    object: Record<string, unknown>,
    path: string,
    splitter = '.'
): T | undefined => {
    if (!path) return undefined;

    const keys = path.split(splitter);
    let value: unknown = object;

    try {
        for (const key of keys) {
            if (!key || !(value instanceof Object) || !(key in value)) return undefined;

            value = (value as Record<string, unknown>)[key];
        }
        return value as T;
    } catch (err) {
        return undefined;
    }
};