es-toolkit 1.13.1-dev.329 → 1.13.1-dev.333

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,34 @@
+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 };
+//# sourceMappingURL=get.mjs.map

package/dist/compat/object/get.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"get.mjs","sources":["../../../src/compat/object/get.ts"],"sourcesContent":["import { isDeepKey } from \"../_internal/isDeepKey.ts\";\nimport { toPath } from \"../_internal/toPath.ts\";\nimport type { Get } from \"./get.types.ts\";\n\n/**\n * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.\n * \n * @template T - The type of the object.\n * @template K - The type of the key in the object.\n * @template D - The type of the default value.\n * \n * @param {T} object - The object to query.\n * @param {K | [K]} path - The path of the property to get.\n * @returns {T[K]} - Returns the resolved value.\n */\nexport function get<T extends object, K extends keyof T>(object: T, path: K | [K]): T[K];\n/**\n * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.\n * \n * @template T - The type of the object.\n * @template K - The type of the key in the object.\n * \n * @param {T | null | undefined} object - The object to query.\n * @param {K | [K]} path - The path of the property to get.\n * @returns {T[K] | undefined} - Returns the resolved value.\n */\nexport function get<T extends object, K extends keyof T>(object: T | null | undefined, path: K | [K]): T[K] | undefined;\n/**\n * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.\n * \n * @template T - The type of the object.\n * @template K - The type of the key in the object.\n * @template D - The type of the default value.\n * \n * @param {T | null | undefined} object - The object to query.\n * @param {K | [K]} path - The path of the property to get.\n * @param {D} defaultValue - The value returned if the resolved value is undefined.\n * @returns {Exclude<T[K], undefined> | D} - Returns the resolved value.\n */\nexport function get<T extends object, K extends keyof T, D>(object: T | null | undefined, path: K | [K], defaultValue: D): Exclude<T[K], undefined> | D;\n/**\n * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.\n * \n * @template T - The type of the object.\n * @template K1 - The type of the first key in the object.\n * @template K2 - The type of the second key in the object.\n * \n * @param {T} object - The object to query.\n * @param {[K1, K2]} path - The path of the property to get.\n * @returns {T[K1][K2]} - Returns the resolved value.\n */\nexport function get<T extends object, K1 extends keyof T, K2 extends keyof T[K1]>(object: T, path: [K1, K2]): T[K1][K2];\n/**\n * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.\n * \n * @template T - The type of the object.\n * @template K1 - The type of the first key in the object.\n * @template K2 - The type of the second key in the object.\n * \n * @param {T | null | undefined} object - The object to query.\n * @param {[K1, K2]} path - The path of the property to get.\n * @returns {T[K1][K2] | undefined} - Returns the resolved value.\n */\nexport 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;\n/**\n * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.\n * \n * @template T - The type of the object.\n * @template K1 - The type of the first key in the object.\n * @template K2 - The type of the second key in the object.\n * @template D - The type of the default value.\n * \n * @param {T | null | undefined} object - The object to query.\n * @param {[K1, K2]} path - The path of the property to get.\n * @param {D} defaultValue - The value returned if the resolved value is undefined.\n * @returns {Exclude<T[K1][K2], undefined> | D} - Returns the resolved value.\n */\nexport 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;\n/**\n * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.\n * \n * @template T - The type of the object.\n * @template K1 - The type of the first key in the object.\n * @template K2 - The type of the second key in the object.\n * @template K3 - The type of the third key in the object.\n * \n * @param {T} object - The object to query.\n * @param {[K1, K2, K3]} path - The path of the property to get.\n * @returns {T[K1][K2][K3]} - Returns the resolved value.\n */\nexport 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];\n/**\n * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.\n * \n * @template T - The type of the object.\n * @template K1 - The type of the first key in the object.\n * @template K2 - The type of the second key in the object.\n * @template K3 - The type of the third key in the object.\n * \n * @param {T | null | undefined} object - The object to query.\n * @param {[K1, K2, K3]} path - The path of the property to get.\n * @returns {T[K1][K2][K3] | undefined} - Returns the resolved value.\n */\nexport 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;\n/**\n * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.\n * \n * @template T - The type of the object.\n * @template K1 - The type of the first key in the object.\n * @template K2 - The type of the second key in the object.\n * @template K3 - The type of the third key in the object.\n * @template D - The type of the default value.\n * \n * @param {T | null | undefined} object - The object to query.\n * @param {[K1, K2, K3]} path - The path of the property to get.\n * @param {D} defaultValue - The value returned if the resolved value is undefined.\n * @returns {Exclude<T[K1][K2][K3], undefined> | D} - Returns the resolved value.\n */\nexport 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;\n/**\n * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.\n * \n * @template T - The type of the object.\n * @template K1 - The type of the first key in the object.\n * @template K2 - The type of the second key in the object.\n * @template K3 - The type of the third key in the object.\n * @template K4 - The type of the fourth key in the object.\n * \n * @param {T} object - The object to query.\n * @param {[K1, K2, K3, K4]} path - The path of the property to get.\n * @returns {T[K1][K2][K3][K4]} - Returns the resolved value.\n */\nexport 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];\n/**\n * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.\n * \n * @template T - The type of the object.\n * @template K1 - The type of the first key in the object.\n * @template K2 - The type of the second key in the object.\n * @template K3 - The type of the third key in the object.\n * @template K4 - The type of the fourth key in the object.\n * \n * @param {T | null | undefined} object - The object to query.\n * @param {[K1, K2, K3, K4]} path - The path of the property to get.\n * @returns {T[K1][K2][K3][K4] | undefined} - Returns the resolved value.\n */\nexport 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;\n/**\n * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.\n * \n * @template T - The type of the object.\n * @template K1 - The type of the first key in the object.\n * @template K2 - The type of the second key in the object.\n * @template K3 - The type of the third key in the object.\n * @template K4 - The type of the fourth key in the object.\n * @template D - The type of the default value.\n * \n * @param {T | null | undefined} object - The object to query.\n * @param {[K1, K2, K3, K4]} path - The path of the property to get.\n * @param {D} defaultValue - The value returned if the resolved value is undefined.\n * @returns {Exclude<T[K1][K2][K3][K4], undefined> | D} - Returns the resolved value.\n */\nexport 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;\n/**\n * Retrieves the value at a given path from an object with numeric keys. If the resolved value is undefined, the defaultValue is returned instead.\n * \n * @template T - The type of the value.\n * \n * @param {Record<number, T>} object - The object to query.\n * @param {number} path - The path of the property to get.\n * @returns {T} - Returns the resolved value.\n */\nexport function get<T>(object: Record<number, T>, path: number): T;\n/**\n * Retrieves the value at a given path from an object with numeric keys. If the resolved value is undefined, the defaultValue is returned instead.\n * \n * @template T - The type of the value.\n * \n * @param {Record<number, T> | null | undefined} object - The object to query.\n * @param {number} path - The path of the property to get.\n * @returns {T | undefined} - Returns the resolved value.\n */\nexport function get<T>(object: Record<number, T> | null | undefined, path: number): T | undefined;\n/**\n * Retrieves the value at a given path from an object with numeric keys. If the resolved value is undefined, the defaultValue is returned instead.\n * \n * @template T - The type of the value.\n * @template D - The type of the default value.\n * \n * @param {Record<number, T> | null | undefined} object - The object to query.\n * @param {number} path - The path of the property to get.\n * @param {D} defaultValue - The value returned if the resolved value is undefined.\n * @returns {T | D} - Returns the resolved value.\n */\nexport function get<T, D>(object: Record<number, T> | null | undefined, path: number, defaultValue: D): T | D;\n/**\n * Retrieves the value at a given path from a null or undefined object, returning the default value.\n * \n * @template D - The type of the default value.\n * \n * @param {null | undefined} object - The object to query.\n * @param {PropertyKey} path - The path of the property to get.\n * @param {D} defaultValue - The value returned if the resolved value is undefined.\n * @returns {D} - Returns the default value.\n */\nexport function get<D>(object: null | undefined, path: PropertyKey, defaultValue: D): D;\n/**\n * Retrieves the value at a given path from a null or undefined object, returning undefined.\n * \n * @param {null | undefined} object - The object to query.\n * @param {PropertyKey} path - The path of the property to get.\n * @returns {undefined} - Returns undefined.\n */\nexport function get(object: null | undefined, path: PropertyKey): undefined;\n/**\n * Retrieves the value at a given path from a string-keyed object. If the resolved value is undefined, the defaultValue is returned instead.\n * \n * @template T - The type of the object.\n * @template P - The type of the path.\n * \n * @param {T} data - The object to query.\n * @param {P} path - The path of the property to get.\n * @returns {string extends P ? any : Get<T, P>} - Returns the resolved value.\n */\nexport function get<T, P extends string>(data: T, path: P): string extends P ? any : Get<T, P>;\n/**\n * Retrieves the value at a given path from a string-keyed object. If the resolved value is undefined, the defaultValue is returned instead.\n * \n * @template T - The type of the object.\n * @template P - The type of the path.\n * @template D - The type of the default value.\n * \n * @param {T} data - The object to query.\n * @param {P} path - The path of the property to get.\n * @param {D} defaultValue - The value returned if the resolved value is undefined.\n * @returns {Exclude<Get<T, P>, null | undefined> | D} - Returns the resolved value.\n */\nexport function get<T, P extends string, D = Get<T, P>>(data: T, path: P, defaultValue: D): Exclude<Get<T, P>, null | undefined> | D;\n/**\n * Retrieves the value at a given path from an object. If the resolved value is undefined, the defaultValue is returned instead.\n * \n * @param {unknown} object - The object to query.\n * @param {PropertyKey | readonly PropertyKey[]} path - The path of the property to get.\n * @param {unknown} [defaultValue] - The value returned if the resolved value is undefined.\n * @returns {any} - Returns the resolved value.\n */\nexport function get(object: unknown, path: PropertyKey | readonly PropertyKey[], defaultValue?: unknown): any;\nexport function get(object: any, path: PropertyKey | readonly PropertyKey[], defaultValue?: any): any {\n  let resolvedPath;\n\n  if (Array.isArray(path)) {\n    resolvedPath = path;\n  } else if (typeof path === 'string' && isDeepKey(path) && object?.[path] == null) {\n    resolvedPath = toPath(path);\n  } else {\n    resolvedPath = [path];\n  }\n\n  if (resolvedPath.length === 0) {\n    return defaultValue;\n  }\n\n  let current = object;\n  let index;\n\n  for (index = 0; index < resolvedPath.length && current != null; index++) {\n    let key = resolvedPath[index];\n\n    if (Object.is(key.valueOf(), -0)) {\n      key = '-0';\n    }\n\n    current = current[key];\n  }\n\n  if (current === null && index === resolvedPath.length) {\n    return current;\n  }\n\n  return current ?? defaultValue;\n}"],"names":[],"mappings":";;;SAuPgB,GAAG,CAAC,MAAW,EAAE,IAA0C,EAAE,YAAkB,EAAA;AAC7F,IAAA,IAAI,YAAY,CAAC;AAEjB,IAAA,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACvB,YAAY,GAAG,IAAI,CAAC;KACrB;AAAM,SAAA,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,MAAM,GAAG,IAAI,CAAC,IAAI,IAAI,EAAE;AAChF,QAAA,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;KAC7B;SAAM;AACL,QAAA,YAAY,GAAG,CAAC,IAAI,CAAC,CAAC;KACvB;AAED,IAAA,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE;AAC7B,QAAA,OAAO,YAAY,CAAC;KACrB;IAED,IAAI,OAAO,GAAG,MAAM,CAAC;AACrB,IAAA,IAAI,KAAK,CAAC;AAEV,IAAA,KAAK,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,YAAY,CAAC,MAAM,IAAI,OAAO,IAAI,IAAI,EAAE,KAAK,EAAE,EAAE;AACvE,QAAA,IAAI,GAAG,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;AAE9B,QAAA,IAAI,MAAM,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE;YAChC,GAAG,GAAG,IAAI,CAAC;SACZ;AAED,QAAA,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;KACxB;IAED,IAAI,OAAO,KAAK,IAAI,IAAI,KAAK,KAAK,YAAY,CAAC,MAAM,EAAE;AACrD,QAAA,OAAO,OAAO,CAAC;KAChB;IAED,OAAO,OAAO,IAAI,YAAY,CAAC;AACjC;;;;"}

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/set.d.mts

@@ -0,0 +1,30 @@
+/**
+ * Sets the value at the specified path of the given object. If any part of the path does not exist, it will be created.
+ *
+ * @template T - The type of the object.
+ * @param {Settable} obj - The object to modify.
+ * @param {Path} path - The path of the property to set.
+ * @param {any} value - The value to set.
+ * @returns {T} - The modified object.
+ *
+ * @example
+ * // Set a value in a nested object
+ * const obj = { a: { b: { c: 3 } } };
+ * set(obj, 'a.b.c', 4);
+ * console.log(obj.a.b.c); // 4
+ *
+ * @example
+ * // Set a value in an array
+ * const arr = [1, 2, 3];
+ * set(arr, 1, 4);
+ * console.log(arr[1]); // 4
+ *
+ * @example
+ * // Create non-existent path and set value
+ * const obj = {};
+ * set(obj, 'a.b.c', 4);
+ * console.log(obj); // { a: { b: { c: 4 } } }
+ */
+declare function set<T>(obj: object, path: PropertyKey | readonly PropertyKey[], value: unknown): T;
+
+export { set };

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

@@ -0,0 +1,30 @@
+/**
+ * Sets the value at the specified path of the given object. If any part of the path does not exist, it will be created.
+ *
+ * @template T - The type of the object.
+ * @param {Settable} obj - The object to modify.
+ * @param {Path} path - The path of the property to set.
+ * @param {any} value - The value to set.
+ * @returns {T} - The modified object.
+ *
+ * @example
+ * // Set a value in a nested object
+ * const obj = { a: { b: { c: 3 } } };
+ * set(obj, 'a.b.c', 4);
+ * console.log(obj.a.b.c); // 4
+ *
+ * @example
+ * // Set a value in an array
+ * const arr = [1, 2, 3];
+ * set(arr, 1, 4);
+ * console.log(arr[1]); // 4
+ *
+ * @example
+ * // Create non-existent path and set value
+ * const obj = {};
+ * set(obj, 'a.b.c', 4);
+ * console.log(obj); // { a: { b: { c: 4 } } }
+ */
+declare function set<T>(obj: object, path: PropertyKey | readonly PropertyKey[], value: unknown): T;
+
+export { set };