es-toolkit 1.13.1 → 1.14.0-dev.399

package/dist/compat/object/get.d.mts

@@ -0,0 +1,247 @@
+import { Get } from './get.types.mjs';
+
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K - The type of the key in the object.
+ * @template D - The type of the default value.
+ *
+ * @param {T} object - The object to query.
+ * @param {K | [K]} path - The path of the property to get.
+ * @returns {T[K]} - Returns the resolved value.
+ */
+declare function get<T extends object, K extends keyof T>(object: T, path: K | [K]): T[K];
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K - The type of the key in the object.
+ *
+ * @param {T | null | undefined} object - The object to query.
+ * @param {K | [K]} path - The path of the property to get.
+ * @returns {T[K] | undefined} - Returns the resolved value.
+ */
+declare function get<T extends object, K extends keyof T>(object: T | null | undefined, path: K | [K]): T[K] | undefined;
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K - The type of the key in the object.
+ * @template D - The type of the default value.
+ *
+ * @param {T | null | undefined} object - The object to query.
+ * @param {K | [K]} path - The path of the property to get.
+ * @param {D} defaultValue - The value returned if the resolved value is undefined.
+ * @returns {Exclude<T[K], undefined> | D} - Returns the resolved value.
+ */
+declare function get<T extends object, K extends keyof T, D>(object: T | null | undefined, path: K | [K], defaultValue: D): Exclude<T[K], undefined> | D;
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ *
+ * @param {T} object - The object to query.
+ * @param {[K1, K2]} path - The path of the property to get.
+ * @returns {T[K1][K2]} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1]>(object: T, path: [K1, K2]): T[K1][K2];
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ *
+ * @param {T | null | undefined} object - The object to query.
+ * @param {[K1, K2]} path - The path of the property to get.
+ * @returns {T[K1][K2] | undefined} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1]>(object: T | null | undefined, path: [K1, K2]): T[K1][K2] | undefined;
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ * @template D - The type of the default value.
+ *
+ * @param {T | null | undefined} object - The object to query.
+ * @param {[K1, K2]} path - The path of the property to get.
+ * @param {D} defaultValue - The value returned if the resolved value is undefined.
+ * @returns {Exclude<T[K1][K2], undefined> | D} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1], D>(object: T | null | undefined, path: [K1, K2], defaultValue: D): Exclude<T[K1][K2], undefined> | D;
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ * @template K3 - The type of the third key in the object.
+ *
+ * @param {T} object - The object to query.
+ * @param {[K1, K2, K3]} path - The path of the property to get.
+ * @returns {T[K1][K2][K3]} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1], K3 extends keyof T[K1][K2]>(object: T, path: [K1, K2, K3]): T[K1][K2][K3];
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ * @template K3 - The type of the third key in the object.
+ *
+ * @param {T | null | undefined} object - The object to query.
+ * @param {[K1, K2, K3]} path - The path of the property to get.
+ * @returns {T[K1][K2][K3] | undefined} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1], K3 extends keyof T[K1][K2]>(object: T | null | undefined, path: [K1, K2, K3]): T[K1][K2][K3] | undefined;
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ * @template K3 - The type of the third key in the object.
+ * @template D - The type of the default value.
+ *
+ * @param {T | null | undefined} object - The object to query.
+ * @param {[K1, K2, K3]} path - The path of the property to get.
+ * @param {D} defaultValue - The value returned if the resolved value is undefined.
+ * @returns {Exclude<T[K1][K2][K3], undefined> | D} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1], K3 extends keyof T[K1][K2], D>(object: T | null | undefined, path: [K1, K2, K3], defaultValue: D): Exclude<T[K1][K2][K3], undefined> | D;
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ * @template K3 - The type of the third key in the object.
+ * @template K4 - The type of the fourth key in the object.
+ *
+ * @param {T} object - The object to query.
+ * @param {[K1, K2, K3, K4]} path - The path of the property to get.
+ * @returns {T[K1][K2][K3][K4]} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1], K3 extends keyof T[K1][K2], K4 extends keyof T[K1][K2][K3]>(object: T, path: [K1, K2, K3, K4]): T[K1][K2][K3][K4];
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ * @template K3 - The type of the third key in the object.
+ * @template K4 - The type of the fourth key in the object.
+ *
+ * @param {T | null | undefined} object - The object to query.
+ * @param {[K1, K2, K3, K4]} path - The path of the property to get.
+ * @returns {T[K1][K2][K3][K4] | undefined} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1], K3 extends keyof T[K1][K2], K4 extends keyof T[K1][K2][K3]>(object: T | null | undefined, path: [K1, K2, K3, K4]): T[K1][K2][K3][K4] | undefined;
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ * @template K3 - The type of the third key in the object.
+ * @template K4 - The type of the fourth key in the object.
+ * @template D - The type of the default value.
+ *
+ * @param {T | null | undefined} object - The object to query.
+ * @param {[K1, K2, K3, K4]} path - The path of the property to get.
+ * @param {D} defaultValue - The value returned if the resolved value is undefined.
+ * @returns {Exclude<T[K1][K2][K3][K4], undefined> | D} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1], K3 extends keyof T[K1][K2], K4 extends keyof T[K1][K2][K3], D>(object: T | null | undefined, path: [K1, K2, K3, K4], defaultValue: D): Exclude<T[K1][K2][K3][K4], undefined> | D;
+/**
+ * Retrieves the value at a given path from an object with numeric keys. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the value.
+ *
+ * @param {Record<number, T>} object - The object to query.
+ * @param {number} path - The path of the property to get.
+ * @returns {T} - Returns the resolved value.
+ */
+declare function get<T>(object: Record<number, T>, path: number): T;
+/**
+ * Retrieves the value at a given path from an object with numeric keys. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the value.
+ *
+ * @param {Record<number, T> | null | undefined} object - The object to query.
+ * @param {number} path - The path of the property to get.
+ * @returns {T | undefined} - Returns the resolved value.
+ */
+declare function get<T>(object: Record<number, T> | null | undefined, path: number): T | undefined;
+/**
+ * Retrieves the value at a given path from an object with numeric keys. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the value.
+ * @template D - The type of the default value.
+ *
+ * @param {Record<number, T> | null | undefined} object - The object to query.
+ * @param {number} path - The path of the property to get.
+ * @param {D} defaultValue - The value returned if the resolved value is undefined.
+ * @returns {T | D} - Returns the resolved value.
+ */
+declare function get<T, D>(object: Record<number, T> | null | undefined, path: number, defaultValue: D): T | D;
+/**
+ * Retrieves the value at a given path from a null or undefined object, returning the default value.
+ *
+ * @template D - The type of the default value.
+ *
+ * @param {null | undefined} object - The object to query.
+ * @param {PropertyKey} path - The path of the property to get.
+ * @param {D} defaultValue - The value returned if the resolved value is undefined.
+ * @returns {D} - Returns the default value.
+ */
+declare function get<D>(object: null | undefined, path: PropertyKey, defaultValue: D): D;
+/**
+ * Retrieves the value at a given path from a null or undefined object, returning undefined.
+ *
+ * @param {null | undefined} object - The object to query.
+ * @param {PropertyKey} path - The path of the property to get.
+ * @returns {undefined} - Returns undefined.
+ */
+declare function get(object: null | undefined, path: PropertyKey): undefined;
+/**
+ * Retrieves the value at a given path from a string-keyed object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template P - The type of the path.
+ *
+ * @param {T} data - The object to query.
+ * @param {P} path - The path of the property to get.
+ * @returns {string extends P ? any : Get<T, P>} - Returns the resolved value.
+ */
+declare function get<T, P extends string>(data: T, path: P): string extends P ? any : Get<T, P>;
+/**
+ * Retrieves the value at a given path from a string-keyed object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template P - The type of the path.
+ * @template D - The type of the default value.
+ *
+ * @param {T} data - The object to query.
+ * @param {P} path - The path of the property to get.
+ * @param {D} defaultValue - The value returned if the resolved value is undefined.
+ * @returns {Exclude<Get<T, P>, null | undefined> | D} - Returns the resolved value.
+ */
+declare function get<T, P extends string, D = Get<T, P>>(data: T, path: P, defaultValue: D): Exclude<Get<T, P>, null | undefined> | D;
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @param {unknown} object - The object to query.
+ * @param {PropertyKey | readonly PropertyKey[]} path - The path of the property to get.
+ * @param {unknown} [defaultValue] - The value returned if the resolved value is undefined.
+ * @returns {any} - Returns the resolved value.
+ */
+declare function get(object: unknown, path: PropertyKey | readonly PropertyKey[], defaultValue?: unknown): any;
+
+export { get };

package/dist/compat/object/get.d.ts

@@ -0,0 +1,247 @@
+import { Get } from './get.types.js';
+
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K - The type of the key in the object.
+ * @template D - The type of the default value.
+ *
+ * @param {T} object - The object to query.
+ * @param {K | [K]} path - The path of the property to get.
+ * @returns {T[K]} - Returns the resolved value.
+ */
+declare function get<T extends object, K extends keyof T>(object: T, path: K | [K]): T[K];
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K - The type of the key in the object.
+ *
+ * @param {T | null | undefined} object - The object to query.
+ * @param {K | [K]} path - The path of the property to get.
+ * @returns {T[K] | undefined} - Returns the resolved value.
+ */
+declare function get<T extends object, K extends keyof T>(object: T | null | undefined, path: K | [K]): T[K] | undefined;
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K - The type of the key in the object.
+ * @template D - The type of the default value.
+ *
+ * @param {T | null | undefined} object - The object to query.
+ * @param {K | [K]} path - The path of the property to get.
+ * @param {D} defaultValue - The value returned if the resolved value is undefined.
+ * @returns {Exclude<T[K], undefined> | D} - Returns the resolved value.
+ */
+declare function get<T extends object, K extends keyof T, D>(object: T | null | undefined, path: K | [K], defaultValue: D): Exclude<T[K], undefined> | D;
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ *
+ * @param {T} object - The object to query.
+ * @param {[K1, K2]} path - The path of the property to get.
+ * @returns {T[K1][K2]} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1]>(object: T, path: [K1, K2]): T[K1][K2];
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ *
+ * @param {T | null | undefined} object - The object to query.
+ * @param {[K1, K2]} path - The path of the property to get.
+ * @returns {T[K1][K2] | undefined} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1]>(object: T | null | undefined, path: [K1, K2]): T[K1][K2] | undefined;
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ * @template D - The type of the default value.
+ *
+ * @param {T | null | undefined} object - The object to query.
+ * @param {[K1, K2]} path - The path of the property to get.
+ * @param {D} defaultValue - The value returned if the resolved value is undefined.
+ * @returns {Exclude<T[K1][K2], undefined> | D} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1], D>(object: T | null | undefined, path: [K1, K2], defaultValue: D): Exclude<T[K1][K2], undefined> | D;
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ * @template K3 - The type of the third key in the object.
+ *
+ * @param {T} object - The object to query.
+ * @param {[K1, K2, K3]} path - The path of the property to get.
+ * @returns {T[K1][K2][K3]} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1], K3 extends keyof T[K1][K2]>(object: T, path: [K1, K2, K3]): T[K1][K2][K3];
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ * @template K3 - The type of the third key in the object.
+ *
+ * @param {T | null | undefined} object - The object to query.
+ * @param {[K1, K2, K3]} path - The path of the property to get.
+ * @returns {T[K1][K2][K3] | undefined} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1], K3 extends keyof T[K1][K2]>(object: T | null | undefined, path: [K1, K2, K3]): T[K1][K2][K3] | undefined;
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ * @template K3 - The type of the third key in the object.
+ * @template D - The type of the default value.
+ *
+ * @param {T | null | undefined} object - The object to query.
+ * @param {[K1, K2, K3]} path - The path of the property to get.
+ * @param {D} defaultValue - The value returned if the resolved value is undefined.
+ * @returns {Exclude<T[K1][K2][K3], undefined> | D} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1], K3 extends keyof T[K1][K2], D>(object: T | null | undefined, path: [K1, K2, K3], defaultValue: D): Exclude<T[K1][K2][K3], undefined> | D;
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ * @template K3 - The type of the third key in the object.
+ * @template K4 - The type of the fourth key in the object.
+ *
+ * @param {T} object - The object to query.
+ * @param {[K1, K2, K3, K4]} path - The path of the property to get.
+ * @returns {T[K1][K2][K3][K4]} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1], K3 extends keyof T[K1][K2], K4 extends keyof T[K1][K2][K3]>(object: T, path: [K1, K2, K3, K4]): T[K1][K2][K3][K4];
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ * @template K3 - The type of the third key in the object.
+ * @template K4 - The type of the fourth key in the object.
+ *
+ * @param {T | null | undefined} object - The object to query.
+ * @param {[K1, K2, K3, K4]} path - The path of the property to get.
+ * @returns {T[K1][K2][K3][K4] | undefined} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1], K3 extends keyof T[K1][K2], K4 extends keyof T[K1][K2][K3]>(object: T | null | undefined, path: [K1, K2, K3, K4]): T[K1][K2][K3][K4] | undefined;
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the first key in the object.
+ * @template K2 - The type of the second key in the object.
+ * @template K3 - The type of the third key in the object.
+ * @template K4 - The type of the fourth key in the object.
+ * @template D - The type of the default value.
+ *
+ * @param {T | null | undefined} object - The object to query.
+ * @param {[K1, K2, K3, K4]} path - The path of the property to get.
+ * @param {D} defaultValue - The value returned if the resolved value is undefined.
+ * @returns {Exclude<T[K1][K2][K3][K4], undefined> | D} - Returns the resolved value.
+ */
+declare function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1], K3 extends keyof T[K1][K2], K4 extends keyof T[K1][K2][K3], D>(object: T | null | undefined, path: [K1, K2, K3, K4], defaultValue: D): Exclude<T[K1][K2][K3][K4], undefined> | D;
+/**
+ * Retrieves the value at a given path from an object with numeric keys. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the value.
+ *
+ * @param {Record<number, T>} object - The object to query.
+ * @param {number} path - The path of the property to get.
+ * @returns {T} - Returns the resolved value.
+ */
+declare function get<T>(object: Record<number, T>, path: number): T;
+/**
+ * Retrieves the value at a given path from an object with numeric keys. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the value.
+ *
+ * @param {Record<number, T> | null | undefined} object - The object to query.
+ * @param {number} path - The path of the property to get.
+ * @returns {T | undefined} - Returns the resolved value.
+ */
+declare function get<T>(object: Record<number, T> | null | undefined, path: number): T | undefined;
+/**
+ * Retrieves the value at a given path from an object with numeric keys. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the value.
+ * @template D - The type of the default value.
+ *
+ * @param {Record<number, T> | null | undefined} object - The object to query.
+ * @param {number} path - The path of the property to get.
+ * @param {D} defaultValue - The value returned if the resolved value is undefined.
+ * @returns {T | D} - Returns the resolved value.
+ */
+declare function get<T, D>(object: Record<number, T> | null | undefined, path: number, defaultValue: D): T | D;
+/**
+ * Retrieves the value at a given path from a null or undefined object, returning the default value.
+ *
+ * @template D - The type of the default value.
+ *
+ * @param {null | undefined} object - The object to query.
+ * @param {PropertyKey} path - The path of the property to get.
+ * @param {D} defaultValue - The value returned if the resolved value is undefined.
+ * @returns {D} - Returns the default value.
+ */
+declare function get<D>(object: null | undefined, path: PropertyKey, defaultValue: D): D;
+/**
+ * Retrieves the value at a given path from a null or undefined object, returning undefined.
+ *
+ * @param {null | undefined} object - The object to query.
+ * @param {PropertyKey} path - The path of the property to get.
+ * @returns {undefined} - Returns undefined.
+ */
+declare function get(object: null | undefined, path: PropertyKey): undefined;
+/**
+ * Retrieves the value at a given path from a string-keyed object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template P - The type of the path.
+ *
+ * @param {T} data - The object to query.
+ * @param {P} path - The path of the property to get.
+ * @returns {string extends P ? any : Get<T, P>} - Returns the resolved value.
+ */
+declare function get<T, P extends string>(data: T, path: P): string extends P ? any : Get<T, P>;
+/**
+ * Retrieves the value at a given path from a string-keyed object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @template T - The type of the object.
+ * @template P - The type of the path.
+ * @template D - The type of the default value.
+ *
+ * @param {T} data - The object to query.
+ * @param {P} path - The path of the property to get.
+ * @param {D} defaultValue - The value returned if the resolved value is undefined.
+ * @returns {Exclude<Get<T, P>, null | undefined> | D} - Returns the resolved value.
+ */
+declare function get<T, P extends string, D = Get<T, P>>(data: T, path: P, defaultValue: D): Exclude<Get<T, P>, null | undefined> | D;
+/**
+ * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.
+ *
+ * @param {unknown} object - The object to query.
+ * @param {PropertyKey | readonly PropertyKey[]} path - The path of the property to get.
+ * @param {unknown} [defaultValue] - The value returned if the resolved value is undefined.
+ * @returns {any} - Returns the resolved value.
+ */
+declare function get(object: unknown, path: PropertyKey | readonly PropertyKey[], defaultValue?: unknown): any;
+
+export { get };

package/dist/compat/object/get.mjs

@@ -0,0 +1,33 @@
+import { isDeepKey } from '../_internal/isDeepKey.mjs';
+import { toPath } from '../_internal/toPath.mjs';
+
+function get(object, path, defaultValue) {
+    let resolvedPath;
+    if (Array.isArray(path)) {
+        resolvedPath = path;
+    }
+    else if (typeof path === 'string' && isDeepKey(path) && object?.[path] == null) {
+        resolvedPath = toPath(path);
+    }
+    else {
+        resolvedPath = [path];
+    }
+    if (resolvedPath.length === 0) {
+        return defaultValue;
+    }
+    let current = object;
+    let index;
+    for (index = 0; index < resolvedPath.length && current != null; index++) {
+        let key = resolvedPath[index];
+        if (Object.is(key.valueOf(), -0)) {
+            key = '-0';
+        }
+        current = current[key];
+    }
+    if (current === null && index === resolvedPath.length) {
+        return current;
+    }
+    return current ?? defaultValue;
+}
+
+export { get };

package/dist/compat/object/get.types.d.mts

@@ -0,0 +1,9 @@
+/**
+ * See the definition of `@types/lodash`.
+ */
+type GetIndexedField<T, K> = K extends keyof T ? T[K] : K extends `${number}` ? 'length' extends keyof T ? number extends T['length'] ? number extends keyof T ? T[number] : undefined : undefined : undefined : undefined;
+type FieldWithPossiblyUndefined<T, Key> = Get<Exclude<T, undefined>, Key> | Extract<T, undefined>;
+type IndexedFieldWithPossiblyUndefined<T, Key> = GetIndexedField<Exclude<T, undefined>, Key> | Extract<T, undefined>;
+type Get<T, P> = P extends `${infer Left}.${infer Right}` ? Left extends keyof Exclude<T, undefined> ? FieldWithPossiblyUndefined<Exclude<T, undefined>[Left], Right> | Extract<T, undefined> : Left extends `${infer FieldKey}[${infer IndexKey}]` ? FieldKey extends keyof T ? FieldWithPossiblyUndefined<IndexedFieldWithPossiblyUndefined<T[FieldKey], IndexKey>, Right> : undefined : undefined : P extends keyof T ? T[P] : P extends `${infer FieldKey}[${infer IndexKey}]` ? FieldKey extends keyof T ? IndexedFieldWithPossiblyUndefined<T[FieldKey], IndexKey> : undefined : IndexedFieldWithPossiblyUndefined<T, P>;
+
+export type { Get };

package/dist/compat/object/get.types.d.ts

@@ -0,0 +1,9 @@
+/**
+ * See the definition of `@types/lodash`.
+ */
+type GetIndexedField<T, K> = K extends keyof T ? T[K] : K extends `${number}` ? 'length' extends keyof T ? number extends T['length'] ? number extends keyof T ? T[number] : undefined : undefined : undefined : undefined;
+type FieldWithPossiblyUndefined<T, Key> = Get<Exclude<T, undefined>, Key> | Extract<T, undefined>;
+type IndexedFieldWithPossiblyUndefined<T, Key> = GetIndexedField<Exclude<T, undefined>, Key> | Extract<T, undefined>;
+type Get<T, P> = P extends `${infer Left}.${infer Right}` ? Left extends keyof Exclude<T, undefined> ? FieldWithPossiblyUndefined<Exclude<T, undefined>[Left], Right> | Extract<T, undefined> : Left extends `${infer FieldKey}[${infer IndexKey}]` ? FieldKey extends keyof T ? FieldWithPossiblyUndefined<IndexedFieldWithPossiblyUndefined<T[FieldKey], IndexKey>, Right> : undefined : undefined : P extends keyof T ? T[P] : P extends `${infer FieldKey}[${infer IndexKey}]` ? FieldKey extends keyof T ? IndexedFieldWithPossiblyUndefined<T[FieldKey], IndexKey> : undefined : IndexedFieldWithPossiblyUndefined<T, P>;
+
+export type { Get };

package/dist/compat/object/mapKeys.d.mts

@@ -0,0 +1,39 @@
+/**
+ * Creates a new object with the same values as the given object, but with keys generated
+ * by running each own enumerable property of the object through the iteratee function.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the keys in the object.
+ *
+ * @param {T} object - The object to iterate over.
+ * @param {PropertyKey | PropertyKey[]} getNewKey - The path of the property to get to generate the new keys.
+ * @returns {Record<K2, T[K1]>} - Returns the new mapped object.
+ *
+ * @example
+ * // Example usage:
+ * const obj = { a: 1, b: 2 };
+ * const result = mapKeys(obj, (value, key) => key + value);
+ * console.log(result); // { a1: 1, b2: 2 }
+ */
+declare function mapKeys<T extends object>(object: T, getNewKey?: PropertyKey | readonly PropertyKey[]): Record<PropertyKey, T[keyof T]>;
+/**
+ * Creates a new object with the same values as the given object, but with keys generated
+ * by running each own enumerable property of the object through the iteratee function.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the keys in the object.
+ * @template K2 - The type of the new keys generated by the iteratee function.
+ *
+ * @param {T} object - The object to iterate over.
+ * @param {(value: T[K1], key: K1, object: T) => K2} getNewKey - The function invoked per own enumerable property.
+ * @returns {Record<K2, T[K1]>} - Returns the new mapped object.
+ *
+ * @example
+ * // Example usage:
+ * const obj = { a: 1, b: 2 };
+ * const result = mapKeys(obj, (value, key) => key + value);
+ * console.log(result); // { a1: 1, b2: 2 }
+ */
+declare function mapKeys<T extends object, K1 extends keyof T, K2 extends PropertyKey>(object: T, getNewKey?: (value: T[K1], key: K1, object: T) => K2): Record<K2, T[K1]>;
+
+export { mapKeys };

package/dist/compat/object/mapKeys.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Creates a new object with the same values as the given object, but with keys generated
+ * by running each own enumerable property of the object through the iteratee function.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the keys in the object.
+ *
+ * @param {T} object - The object to iterate over.
+ * @param {PropertyKey | PropertyKey[]} getNewKey - The path of the property to get to generate the new keys.
+ * @returns {Record<K2, T[K1]>} - Returns the new mapped object.
+ *
+ * @example
+ * // Example usage:
+ * const obj = { a: 1, b: 2 };
+ * const result = mapKeys(obj, (value, key) => key + value);
+ * console.log(result); // { a1: 1, b2: 2 }
+ */
+declare function mapKeys<T extends object>(object: T, getNewKey?: PropertyKey | readonly PropertyKey[]): Record<PropertyKey, T[keyof T]>;
+/**
+ * Creates a new object with the same values as the given object, but with keys generated
+ * by running each own enumerable property of the object through the iteratee function.
+ *
+ * @template T - The type of the object.
+ * @template K1 - The type of the keys in the object.
+ * @template K2 - The type of the new keys generated by the iteratee function.
+ *
+ * @param {T} object - The object to iterate over.
+ * @param {(value: T[K1], key: K1, object: T) => K2} getNewKey - The function invoked per own enumerable property.
+ * @returns {Record<K2, T[K1]>} - Returns the new mapped object.
+ *
+ * @example
+ * // Example usage:
+ * const obj = { a: 1, b: 2 };
+ * const result = mapKeys(obj, (value, key) => key + value);
+ * console.log(result); // { a1: 1, b2: 2 }
+ */
+declare function mapKeys<T extends object, K1 extends keyof T, K2 extends PropertyKey>(object: T, getNewKey?: (value: T[K1], key: K1, object: T) => K2): Record<K2, T[K1]>;
+
+export { mapKeys };

package/dist/compat/object/mapKeys.mjs

@@ -0,0 +1,20 @@
+import { mapKeys as mapKeys$1 } from '../../object/mapKeys.mjs';
+import { identity } from '../_internal/identity.mjs';
+import { property } from './property.mjs';
+
+function mapKeys(object, getNewKey) {
+    getNewKey = getNewKey ?? identity;
+    switch (typeof getNewKey) {
+        case 'string':
+        case 'symbol':
+        case 'number':
+        case 'object': {
+            return mapKeys$1(object, property(getNewKey));
+        }
+        case 'function': {
+            return mapKeys$1(object, getNewKey);
+        }
+    }
+}
+
+export { mapKeys };