@vinicunca/perkakas 1.5.0 → 1.7.0

package/dist/prop.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkSOPOELNUcjs = require('./chunk-SOPOELNU.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');exports.prop = _chunkSOPOELNUcjs.a; exports.propImplementation = _chunkSOPOELNUcjs.b;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkSOPOELNUcjs = require('./chunk-SOPOELNU.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');require('./chunk-MBGSSEZN.cjs');exports.prop = _chunkSOPOELNUcjs.a; exports.propImplementation = _chunkSOPOELNUcjs.b;

package/dist/prop.js

@@ -1 +1 @@
-import{a,b}from"./chunk-NEIICTWC.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";export{a as prop,b as propImplementation};
+import{a,b}from"./chunk-NEIICTWC.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";import"./chunk-EK7ODJWE.js";export{a as prop,b as propImplementation};

package/dist/pull-object.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkXLGD5ZUYcjs = require('./chunk-XLGD5ZUY.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');exports.pullObject = _chunkXLGD5ZUYcjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkFGMSPUSFcjs = require('./chunk-FGMSPUSF.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');require('./chunk-MBGSSEZN.cjs');exports.pullObject = _chunkFGMSPUSFcjs.a;

package/dist/pull-object.d.cts

@@ -1,7 +1,8 @@
-import { E as ExactRecord } from './exact-record-_isi2JMR.cjs';
+import { B as BoundedPartial } from './bounded-partial-BqwRN49U.cjs';
 import { I as IterableContainer } from './iterable-container-BTpDVdNc.cjs';
-import './if-bounded-record-Drd4UbBU.cjs';
+import './if-D4QIikQ1.cjs';
 import 'type-fest';
+import './is-bounded-record-C9WAwfA8.cjs';
 
 /**
  * Creates an object that maps the result of `valueExtractor` with a key
@@ -34,7 +35,7 @@ import 'type-fest';
  * @dataFirst
  * @category Object
  */
-declare function pullObject<T extends IterableContainer, K extends PropertyKey, V>(data: T, keyExtractor: (item: T[number], index: number, data: T) => K, valueExtractor: (item: T[number], index: number, data: T) => V): ExactRecord<K, V>;
+declare function pullObject<T extends IterableContainer, K extends PropertyKey, V>(data: T, keyExtractor: (item: T[number], index: number, data: T) => K, valueExtractor: (item: T[number], index: number, data: T) => V): BoundedPartial<Record<K, V>>;
 /**
  * Creates an object that maps the result of `valueExtractor` with a key
  * resulting from running `keyExtractor` on each item in `data`. Duplicate keys
@@ -64,6 +65,6 @@ declare function pullObject<T extends IterableContainer, K extends PropertyKey,
  * @dataLast
  * @category Object
  */
-declare function pullObject<T extends IterableContainer, K extends PropertyKey, V>(keyExtractor: (item: T[number], index: number, data: T) => K, valueExtractor: (item: T[number], index: number, data: T) => V): (data: T) => ExactRecord<K, V>;
+declare function pullObject<T extends IterableContainer, K extends PropertyKey, V>(keyExtractor: (item: T[number], index: number, data: T) => K, valueExtractor: (item: T[number], index: number, data: T) => V): (data: T) => BoundedPartial<Record<K, V>>;
 
 export { pullObject };

package/dist/pull-object.d.ts

@@ -1,7 +1,8 @@
-import { E as ExactRecord } from './exact-record-Dhbe_K-E.js';
+import { B as BoundedPartial } from './bounded-partial-BzynYDVs.js';
 import { I as IterableContainer } from './iterable-container-BTpDVdNc.js';
-import './if-bounded-record-Drd4UbBU.js';
+import './if-D4QIikQ1.js';
 import 'type-fest';
+import './is-bounded-record-C9WAwfA8.js';
 
 /**
  * Creates an object that maps the result of `valueExtractor` with a key
@@ -34,7 +35,7 @@ import 'type-fest';
  * @dataFirst
  * @category Object
  */
-declare function pullObject<T extends IterableContainer, K extends PropertyKey, V>(data: T, keyExtractor: (item: T[number], index: number, data: T) => K, valueExtractor: (item: T[number], index: number, data: T) => V): ExactRecord<K, V>;
+declare function pullObject<T extends IterableContainer, K extends PropertyKey, V>(data: T, keyExtractor: (item: T[number], index: number, data: T) => K, valueExtractor: (item: T[number], index: number, data: T) => V): BoundedPartial<Record<K, V>>;
 /**
  * Creates an object that maps the result of `valueExtractor` with a key
  * resulting from running `keyExtractor` on each item in `data`. Duplicate keys
@@ -64,6 +65,6 @@ declare function pullObject<T extends IterableContainer, K extends PropertyKey,
  * @dataLast
  * @category Object
  */
-declare function pullObject<T extends IterableContainer, K extends PropertyKey, V>(keyExtractor: (item: T[number], index: number, data: T) => K, valueExtractor: (item: T[number], index: number, data: T) => V): (data: T) => ExactRecord<K, V>;
+declare function pullObject<T extends IterableContainer, K extends PropertyKey, V>(keyExtractor: (item: T[number], index: number, data: T) => K, valueExtractor: (item: T[number], index: number, data: T) => V): (data: T) => BoundedPartial<Record<K, V>>;
 
 export { pullObject };

package/dist/pull-object.js

@@ -1 +1 @@
-import{a}from"./chunk-UUYCL4G2.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";export{a as pullObject};
+import{a}from"./chunk-B6SBIS6W.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";import"./chunk-EK7ODJWE.js";export{a as pullObject};

package/dist/random-integer.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkSJMGQLYScjs = require('./chunk-SJMGQLYS.cjs');exports.randomInteger = _chunkSJMGQLYScjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkSJMGQLYScjs = require('./chunk-SJMGQLYS.cjs');require('./chunk-MBGSSEZN.cjs');exports.randomInteger = _chunkSJMGQLYScjs.a;

package/dist/random-integer.js

@@ -1 +1 @@
-import{a}from"./chunk-I2Z6A55T.js";export{a as randomInteger};
+import{a}from"./chunk-I2Z6A55T.js";import"./chunk-EK7ODJWE.js";export{a as randomInteger};

package/dist/random-string.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunk63GGX2BScjs = require('./chunk-63GGX2BS.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');exports.randomString = _chunk63GGX2BScjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunk63GGX2BScjs = require('./chunk-63GGX2BS.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');require('./chunk-MBGSSEZN.cjs');exports.randomString = _chunk63GGX2BScjs.a;

package/dist/random-string.js

@@ -1 +1 @@
-import{a}from"./chunk-U6ZJSHFS.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";export{a as randomString};
+import{a}from"./chunk-U6ZJSHFS.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";import"./chunk-EK7ODJWE.js";export{a as randomString};

package/dist/range.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkAPO7U7HGcjs = require('./chunk-APO7U7HG.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');exports.range = _chunkAPO7U7HGcjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkAPO7U7HGcjs = require('./chunk-APO7U7HG.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');require('./chunk-MBGSSEZN.cjs');exports.range = _chunkAPO7U7HGcjs.a;

package/dist/range.js

@@ -1 +1 @@
-import{a}from"./chunk-XWQ3IM2J.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";export{a as range};
+import{a}from"./chunk-XWQ3IM2J.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";import"./chunk-EK7ODJWE.js";export{a as range};

package/dist/rank-by.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkZLNSRDW7cjs = require('./chunk-ZLNSRDW7.cjs');require('./chunk-EROXO3T4.cjs');exports.rankBy = _chunkZLNSRDW7cjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkZLNSRDW7cjs = require('./chunk-ZLNSRDW7.cjs');require('./chunk-EROXO3T4.cjs');require('./chunk-MBGSSEZN.cjs');exports.rankBy = _chunkZLNSRDW7cjs.a;

package/dist/rank-by.d.cts

@@ -1,5 +1,5 @@
-import { N as NonEmptyArray } from './non-empty-array-C9Od1wmF.cjs';
 import { O as OrderRule } from './curry-order-rules-BKXCPBNx.cjs';
+import { N as NonEmptyArray } from './non-empty-array-C9Od1wmF.cjs';
 
 /**
  * Calculates the rank of an item in an array based on `rules`. The rank is the position where the item would appear in the sorted array. This function provides an efficient way to determine the rank in *O(n)* time, compared to *O(nlogn)* for the equivalent `sortedIndex(sortBy(data, ...rules), item)`.

package/dist/rank-by.d.ts

@@ -1,5 +1,5 @@
-import { N as NonEmptyArray } from './non-empty-array-C9Od1wmF.js';
 import { O as OrderRule } from './curry-order-rules-BKXCPBNx.js';
+import { N as NonEmptyArray } from './non-empty-array-C9Od1wmF.js';
 
 /**
  * Calculates the rank of an item in an array based on `rules`. The rank is the position where the item would appear in the sorted array. This function provides an efficient way to determine the rank in *O(n)* time, compared to *O(nlogn)* for the equivalent `sortedIndex(sortBy(data, ...rules), item)`.

package/dist/rank-by.js

@@ -1 +1 @@
-import{a}from"./chunk-G57ZPKMR.js";import"./chunk-7KBK2RWQ.js";export{a as rankBy};
+import{a}from"./chunk-G57ZPKMR.js";import"./chunk-7KBK2RWQ.js";import"./chunk-EK7ODJWE.js";export{a as rankBy};

package/dist/reduce.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkH6WDSTL3cjs = require('./chunk-H6WDSTL3.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');exports.reduce = _chunkH6WDSTL3cjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkH6WDSTL3cjs = require('./chunk-H6WDSTL3.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');require('./chunk-MBGSSEZN.cjs');exports.reduce = _chunkH6WDSTL3cjs.a;

package/dist/reduce.js

@@ -1 +1 @@
-import{a}from"./chunk-IZWZPKOA.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";export{a as reduce};
+import{a}from"./chunk-IZWZPKOA.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";import"./chunk-EK7ODJWE.js";export{a as reduce};

package/dist/reverse.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkVAU7HZPOcjs = require('./chunk-VAU7HZPO.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');exports.reverse = _chunkVAU7HZPOcjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkVAU7HZPOcjs = require('./chunk-VAU7HZPO.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');require('./chunk-MBGSSEZN.cjs');exports.reverse = _chunkVAU7HZPOcjs.a;

package/dist/reverse.js

@@ -1 +1 @@
-import{a}from"./chunk-JNQXGRDN.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";export{a as reverse};
+import{a}from"./chunk-JNQXGRDN.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";import"./chunk-EK7ODJWE.js";export{a as reverse};

package/dist/round.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkIRWDTBZTcjs = require('./chunk-IRWDTBZT.cjs');require('./chunk-M22GUUVY.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');exports.round = _chunkIRWDTBZTcjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkIRWDTBZTcjs = require('./chunk-IRWDTBZT.cjs');require('./chunk-M22GUUVY.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');require('./chunk-MBGSSEZN.cjs');exports.round = _chunkIRWDTBZTcjs.a;

package/dist/round.js

@@ -1 +1 @@
-import{a}from"./chunk-P4HDHWKF.js";import"./chunk-PEJ74NWA.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";export{a as round};
+import{a}from"./chunk-P4HDHWKF.js";import"./chunk-PEJ74NWA.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";import"./chunk-EK7ODJWE.js";export{a as round};

package/dist/sample.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunk2MHE6M7Vcjs = require('./chunk-2MHE6M7V.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');exports.sample = _chunk2MHE6M7Vcjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunk2MHE6M7Vcjs = require('./chunk-2MHE6M7V.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');require('./chunk-MBGSSEZN.cjs');exports.sample = _chunk2MHE6M7Vcjs.a;

package/dist/sample.js

@@ -1 +1 @@
-import{a}from"./chunk-XEAAXO7F.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";export{a as sample};
+import{a}from"./chunk-XEAAXO7F.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";import"./chunk-EK7ODJWE.js";export{a as sample};

package/dist/set-path.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkNQGMUM3Ecjs = require('./chunk-NQGMUM3E.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');exports.setPath = _chunkNQGMUM3Ecjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkSG2YWG6Ucjs = require('./chunk-SG2YWG6U.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');require('./chunk-MBGSSEZN.cjs');exports.setPath = _chunkSG2YWG6Ucjs.a;

package/dist/set-path.d.cts

@@ -1,8 +1,19 @@
-type Path<T, Prefix extends ReadonlyArray<unknown> = []> = T extends ReadonlyArray<unknown> ? Path<T[number], [...Prefix, number]> | Prefix : T extends Record<PropertyKey, unknown> ? PathsOfObject<T, Prefix> | Prefix : Prefix;
-type PathsOfObject<T, Prefix extends ReadonlyArray<unknown>> = {
-    [K in keyof T]-?: Path<T[K], readonly [...Prefix, K]>;
-}[keyof T];
-type ValueAtPath<T, TPath> = TPath extends readonly [
+import { ValueOf } from 'type-fest';
+import { P as PerkakasTypeError } from './perkakas-type-error-8wPb8T2y.cjs';
+
+type Paths<T, Prefix extends ReadonlyArray<unknown> = []> = Prefix | (T extends object ? ValueOf<{
+    [K in ProperKeyOf<T>]-?: Paths<T[K], [...Prefix, K]>;
+}> : PerkakasTypeError<'setPath', 'Can only compute paths objects', {
+    type: never;
+    metadata: T;
+}>) extends infer Path ? Readonly<Path> : never;
+/**
+ * Array objects have all Array.prototype keys in their "keyof" type, which
+ * is not what we'd expect from the operator. We only want the numeric keys
+ * which represent proper elements of the array.
+ */
+type ProperKeyOf<T> = Extract<keyof T, T extends ReadonlyArray<unknown> ? number : keyof T>;
+type ValueAtPath<T, Path> = Path extends readonly [
     infer Head extends keyof T,
     ...infer Rest
 ] ? ValueAtPath<T[Head], Rest> : T;
@@ -21,7 +32,7 @@ type ValueAtPath<T, TPath> = TPath extends readonly [
  * @dataFirst
  * @category Object
  */
-declare function setPath<T, TPath extends Path<T>>(data: T, path: TPath, value: ValueAtPath<T, TPath>): T;
+declare function setPath<T, Path extends Paths<T>>(data: T, path: Path, value: ValueAtPath<T, Path>): T;
 /**
  * Sets the value at `path` of `object`.
  *
@@ -34,6 +45,6 @@ declare function setPath<T, TPath extends Path<T>>(data: T, path: TPath, value:
  * @dataLast
  * @category Object
  */
-declare function setPath<T, TPath extends Path<T>, Value extends ValueAtPath<T, TPath>>(path: TPath, value: Value): (data: T) => T;
+declare function setPath<T, Path extends Paths<T>, Value extends ValueAtPath<T, Path>>(path: Path, value: Value): (data: T) => T;
 
 export { setPath };

package/dist/set-path.d.ts

@@ -1,8 +1,19 @@
-type Path<T, Prefix extends ReadonlyArray<unknown> = []> = T extends ReadonlyArray<unknown> ? Path<T[number], [...Prefix, number]> | Prefix : T extends Record<PropertyKey, unknown> ? PathsOfObject<T, Prefix> | Prefix : Prefix;
-type PathsOfObject<T, Prefix extends ReadonlyArray<unknown>> = {
-    [K in keyof T]-?: Path<T[K], readonly [...Prefix, K]>;
-}[keyof T];
-type ValueAtPath<T, TPath> = TPath extends readonly [
+import { ValueOf } from 'type-fest';
+import { P as PerkakasTypeError } from './perkakas-type-error-8wPb8T2y.js';
+
+type Paths<T, Prefix extends ReadonlyArray<unknown> = []> = Prefix | (T extends object ? ValueOf<{
+    [K in ProperKeyOf<T>]-?: Paths<T[K], [...Prefix, K]>;
+}> : PerkakasTypeError<'setPath', 'Can only compute paths objects', {
+    type: never;
+    metadata: T;
+}>) extends infer Path ? Readonly<Path> : never;
+/**
+ * Array objects have all Array.prototype keys in their "keyof" type, which
+ * is not what we'd expect from the operator. We only want the numeric keys
+ * which represent proper elements of the array.
+ */
+type ProperKeyOf<T> = Extract<keyof T, T extends ReadonlyArray<unknown> ? number : keyof T>;
+type ValueAtPath<T, Path> = Path extends readonly [
     infer Head extends keyof T,
     ...infer Rest
 ] ? ValueAtPath<T[Head], Rest> : T;
@@ -21,7 +32,7 @@ type ValueAtPath<T, TPath> = TPath extends readonly [
  * @dataFirst
  * @category Object
  */
-declare function setPath<T, TPath extends Path<T>>(data: T, path: TPath, value: ValueAtPath<T, TPath>): T;
+declare function setPath<T, Path extends Paths<T>>(data: T, path: Path, value: ValueAtPath<T, Path>): T;
 /**
  * Sets the value at `path` of `object`.
  *
@@ -34,6 +45,6 @@ declare function setPath<T, TPath extends Path<T>>(data: T, path: TPath, value:
  * @dataLast
  * @category Object
  */
-declare function setPath<T, TPath extends Path<T>, Value extends ValueAtPath<T, TPath>>(path: TPath, value: Value): (data: T) => T;
+declare function setPath<T, Path extends Paths<T>, Value extends ValueAtPath<T, Path>>(path: Path, value: Value): (data: T) => T;
 
 export { setPath };

package/dist/set-path.js

@@ -1 +1 @@
-import{a}from"./chunk-6HSB3NFW.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";export{a as setPath};
+import{a}from"./chunk-OKBFQ7B6.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";import"./chunk-EK7ODJWE.js";export{a as setPath};

package/dist/set.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkOBX5B27Bcjs = require('./chunk-OBX5B27B.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');exports.set = _chunkOBX5B27Bcjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkOBX5B27Bcjs = require('./chunk-OBX5B27B.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');require('./chunk-MBGSSEZN.cjs');exports.set = _chunkOBX5B27Bcjs.a;

package/dist/set.d.cts

@@ -1,4 +1,4 @@
-import { U as UpsertProp } from './upsert-prop-tIHFi_F_.cjs';
+import { U as UpsertProp } from './upsert-prop-Cc3jEW9l.cjs';
 import 'type-fest';
 import './is-union-Bx34mF34.cjs';
 

package/dist/set.d.ts

@@ -1,4 +1,4 @@
-import { U as UpsertProp } from './upsert-prop-D0N8486l.js';
+import { U as UpsertProp } from './upsert-prop-CdUtD50i.js';
 import 'type-fest';
 import './is-union-Bx34mF34.js';
 

package/dist/set.js

@@ -1 +1 @@
-import{a}from"./chunk-L3FG6LLM.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";export{a as set};
+import{a}from"./chunk-L3FG6LLM.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";import"./chunk-EK7ODJWE.js";export{a as set};

package/dist/shuffle.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkPZSBVMJ5cjs = require('./chunk-PZSBVMJ5.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');exports.shuffle = _chunkPZSBVMJ5cjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkPZSBVMJ5cjs = require('./chunk-PZSBVMJ5.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');require('./chunk-MBGSSEZN.cjs');exports.shuffle = _chunkPZSBVMJ5cjs.a;

package/dist/shuffle.js

@@ -1 +1 @@
-import{a}from"./chunk-ZSKQIU2G.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";export{a as shuffle};
+import{a}from"./chunk-ZSKQIU2G.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";import"./chunk-EK7ODJWE.js";export{a as shuffle};

package/dist/sleep.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkHC3HZK4Qcjs = require('./chunk-HC3HZK4Q.cjs');exports.sleep = _chunkHC3HZK4Qcjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkHC3HZK4Qcjs = require('./chunk-HC3HZK4Q.cjs');require('./chunk-MBGSSEZN.cjs');exports.sleep = _chunkHC3HZK4Qcjs.a;

package/dist/sleep.js

@@ -1 +1 @@
-import{a}from"./chunk-6SYP2DRD.js";export{a as sleep};
+import{a}from"./chunk-6SYP2DRD.js";import"./chunk-EK7ODJWE.js";export{a as sleep};

package/dist/slice-string.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunk3WCOFJCScjs = require('./chunk-3WCOFJCS.cjs');exports.sliceString = _chunk3WCOFJCScjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunk3WCOFJCScjs = require('./chunk-3WCOFJCS.cjs');require('./chunk-MBGSSEZN.cjs');exports.sliceString = _chunk3WCOFJCScjs.a;

package/dist/slice-string.js

@@ -1 +1 @@
-import{a}from"./chunk-FGVDZJ7U.js";export{a as sliceString};
+import{a}from"./chunk-FGVDZJ7U.js";import"./chunk-EK7ODJWE.js";export{a as sliceString};

package/dist/slugify.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkEP626HCIcjs = require('./chunk-EP626HCI.cjs');exports.slugify = _chunkEP626HCIcjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkEP626HCIcjs = require('./chunk-EP626HCI.cjs');require('./chunk-MBGSSEZN.cjs');exports.slugify = _chunkEP626HCIcjs.a;

package/dist/slugify.js

@@ -1 +1 @@
-import{a}from"./chunk-XSSRBOMF.js";export{a as slugify};
+import{a}from"./chunk-XSSRBOMF.js";import"./chunk-EK7ODJWE.js";export{a as slugify};

package/dist/sort-by.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkKM5XOWVGcjs = require('./chunk-KM5XOWVG.cjs');require('./chunk-EROXO3T4.cjs');exports.sortBy = _chunkKM5XOWVGcjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkKM5XOWVGcjs = require('./chunk-KM5XOWVG.cjs');require('./chunk-EROXO3T4.cjs');require('./chunk-MBGSSEZN.cjs');exports.sortBy = _chunkKM5XOWVGcjs.a;

package/dist/sort-by.d.cts

@@ -1,7 +1,7 @@
+import { O as OrderRule } from './curry-order-rules-BKXCPBNx.cjs';
 import { I as IterableContainer } from './iterable-container-BTpDVdNc.cjs';
 import { N as NonEmptyArray } from './non-empty-array-C9Od1wmF.cjs';
 import { R as ReorderedArray } from './reordered-array-DTkM8K3n.cjs';
-import { O as OrderRule } from './curry-order-rules-BKXCPBNx.cjs';
 
 /**
  * Sorts `data` using the provided ordering rules. The `sort` is done via the

package/dist/sort-by.d.ts

@@ -1,7 +1,7 @@
+import { O as OrderRule } from './curry-order-rules-BKXCPBNx.js';
 import { I as IterableContainer } from './iterable-container-BTpDVdNc.js';
 import { N as NonEmptyArray } from './non-empty-array-C9Od1wmF.js';
 import { R as ReorderedArray } from './reordered-array-DVguhAmZ.js';
-import { O as OrderRule } from './curry-order-rules-BKXCPBNx.js';
 
 /**
  * Sorts `data` using the provided ordering rules. The `sort` is done via the

package/dist/sort-by.js

@@ -1 +1 @@
-import{a}from"./chunk-2GPOH4MN.js";import"./chunk-7KBK2RWQ.js";export{a as sortBy};
+import{a}from"./chunk-2GPOH4MN.js";import"./chunk-7KBK2RWQ.js";import"./chunk-EK7ODJWE.js";export{a as sortBy};

package/dist/sort.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkHIEVTRB4cjs = require('./chunk-HIEVTRB4.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');exports.sort = _chunkHIEVTRB4cjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkHIEVTRB4cjs = require('./chunk-HIEVTRB4.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');require('./chunk-MBGSSEZN.cjs');exports.sort = _chunkHIEVTRB4cjs.a;

package/dist/sort.js

@@ -1 +1 @@
-import{a}from"./chunk-ORBI2CZ3.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";export{a as sort};
+import{a}from"./chunk-ORBI2CZ3.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";import"./chunk-EK7ODJWE.js";export{a as sort};

package/dist/sorted-index-by.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkJPW7GBE2cjs = require('./chunk-JPW7GBE2.cjs');require('./chunk-7TDMV2GO.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');exports.sortedIndexBy = _chunkJPW7GBE2cjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkJPW7GBE2cjs = require('./chunk-JPW7GBE2.cjs');require('./chunk-7TDMV2GO.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');require('./chunk-MBGSSEZN.cjs');exports.sortedIndexBy = _chunkJPW7GBE2cjs.a;

package/dist/sorted-index-by.js

@@ -1 +1 @@
-import{a}from"./chunk-BUVPABRX.js";import"./chunk-JZ463SIK.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";export{a as sortedIndexBy};
+import{a}from"./chunk-BUVPABRX.js";import"./chunk-JZ463SIK.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";import"./chunk-EK7ODJWE.js";export{a as sortedIndexBy};

package/dist/sorted-index-with.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkORWRUK3Kcjs = require('./chunk-ORWRUK3K.cjs');require('./chunk-7TDMV2GO.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');exports.sortedIndexWith = _chunkORWRUK3Kcjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkORWRUK3Kcjs = require('./chunk-ORWRUK3K.cjs');require('./chunk-7TDMV2GO.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');require('./chunk-MBGSSEZN.cjs');exports.sortedIndexWith = _chunkORWRUK3Kcjs.a;

package/dist/sorted-index-with.js

@@ -1 +1 @@
-import{a}from"./chunk-SGK2IP3C.js";import"./chunk-JZ463SIK.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";export{a as sortedIndexWith};
+import{a}from"./chunk-SGK2IP3C.js";import"./chunk-JZ463SIK.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";import"./chunk-EK7ODJWE.js";export{a as sortedIndexWith};

package/dist/sorted-index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkBASNU4JYcjs = require('./chunk-BASNU4JY.cjs');require('./chunk-7TDMV2GO.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');exports.sortedIndex = _chunkBASNU4JYcjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkBASNU4JYcjs = require('./chunk-BASNU4JY.cjs');require('./chunk-7TDMV2GO.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');require('./chunk-MBGSSEZN.cjs');exports.sortedIndex = _chunkBASNU4JYcjs.a;

package/dist/sorted-index.js

@@ -1 +1 @@
-import{a}from"./chunk-EFSZB7SJ.js";import"./chunk-JZ463SIK.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";export{a as sortedIndex};
+import{a}from"./chunk-EFSZB7SJ.js";import"./chunk-JZ463SIK.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";import"./chunk-EK7ODJWE.js";export{a as sortedIndex};

package/dist/sorted-last-index-by.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkSNYQNW6Tcjs = require('./chunk-SNYQNW6T.cjs');require('./chunk-7TDMV2GO.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');exports.sortedLastIndexBy = _chunkSNYQNW6Tcjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkSNYQNW6Tcjs = require('./chunk-SNYQNW6T.cjs');require('./chunk-7TDMV2GO.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');require('./chunk-MBGSSEZN.cjs');exports.sortedLastIndexBy = _chunkSNYQNW6Tcjs.a;

package/dist/sorted-last-index-by.js

@@ -1 +1 @@
-import{a}from"./chunk-VJUK4I7J.js";import"./chunk-JZ463SIK.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";export{a as sortedLastIndexBy};
+import{a}from"./chunk-VJUK4I7J.js";import"./chunk-JZ463SIK.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";import"./chunk-EK7ODJWE.js";export{a as sortedLastIndexBy};

package/dist/sorted-last-index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkBX7F2U4Pcjs = require('./chunk-BX7F2U4P.cjs');require('./chunk-7TDMV2GO.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');exports.sortedLastIndex = _chunkBX7F2U4Pcjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkBX7F2U4Pcjs = require('./chunk-BX7F2U4P.cjs');require('./chunk-7TDMV2GO.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');require('./chunk-MBGSSEZN.cjs');exports.sortedLastIndex = _chunkBX7F2U4Pcjs.a;

package/dist/sorted-last-index.js

@@ -1 +1 @@
-import{a}from"./chunk-UXW7KBAK.js";import"./chunk-JZ463SIK.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";export{a as sortedLastIndex};
+import{a}from"./chunk-UXW7KBAK.js";import"./chunk-JZ463SIK.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";import"./chunk-EK7ODJWE.js";export{a as sortedLastIndex};

package/dist/splice.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkGSFIDOPZcjs = require('./chunk-GSFIDOPZ.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');exports.splice = _chunkGSFIDOPZcjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkGSFIDOPZcjs = require('./chunk-GSFIDOPZ.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');require('./chunk-MBGSSEZN.cjs');exports.splice = _chunkGSFIDOPZcjs.a;

package/dist/splice.js

@@ -1 +1 @@
-import{a}from"./chunk-KZJPXI6A.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";export{a as splice};
+import{a}from"./chunk-KZJPXI6A.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";import"./chunk-EK7ODJWE.js";export{a as splice};

package/dist/split-at.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkPM4GAQSEcjs = require('./chunk-PM4GAQSE.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');exports.splitAt = _chunkPM4GAQSEcjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkPM4GAQSEcjs = require('./chunk-PM4GAQSE.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');require('./chunk-MBGSSEZN.cjs');exports.splitAt = _chunkPM4GAQSEcjs.a;

package/dist/split-at.js

@@ -1 +1 @@
-import{a}from"./chunk-N4LC5TR2.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";export{a as splitAt};
+import{a}from"./chunk-N4LC5TR2.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";import"./chunk-EK7ODJWE.js";export{a as splitAt};

package/dist/split-when.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkOCVPUGMZcjs = require('./chunk-OCVPUGMZ.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');exports.splitWhen = _chunkOCVPUGMZcjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkOCVPUGMZcjs = require('./chunk-OCVPUGMZ.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');require('./chunk-MBGSSEZN.cjs');exports.splitWhen = _chunkOCVPUGMZcjs.a;

package/dist/split-when.js

@@ -1 +1 @@
-import{a}from"./chunk-6LM7XJ2A.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";export{a as splitWhen};
+import{a}from"./chunk-6LM7XJ2A.js";import"./chunk-J6WPJH72.js";import"./chunk-KGPDVVVV.js";import"./chunk-EK7ODJWE.js";export{a as splitWhen};

package/dist/split.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkTFN3JWPScjs = require('./chunk-TFN3JWPS.cjs');exports.split = _chunkTFN3JWPScjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkTFN3JWPScjs = require('./chunk-TFN3JWPS.cjs');require('./chunk-MBGSSEZN.cjs');exports.split = _chunkTFN3JWPScjs.a;

package/dist/split.js

@@ -1 +1 @@
-import{a}from"./chunk-RBODUO3Q.js";export{a as split};
+import{a}from"./chunk-RBODUO3Q.js";import"./chunk-EK7ODJWE.js";export{a as split};

package/dist/string-to-path.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkVRZNQSZNcjs = require('./chunk-VRZNQSZN.cjs');exports.stringToPath = _chunkVRZNQSZNcjs.a;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkTSP3FU72cjs = require('./chunk-TSP3FU72.cjs');require('./chunk-MBGSSEZN.cjs');exports.stringToPath = _chunkTSP3FU72cjs.a;

package/dist/string-to-path.d.cts

@@ -1,22 +1,44 @@
-type StringToPath<T extends string> = string extends T ? never : T extends '' ? [] : T extends `${infer Head}[${infer Nest}].${infer Tail}` ? [...StringToPath<Head>, Nest, ...StringToPath<Tail>] : T extends `${infer Head}[${infer Nest}]` ? [...StringToPath<Head>, Nest] : T extends `${infer Head}.${infer Tail}` ? [...StringToPath<Head>, ...StringToPath<Tail>] : [T];
+import { IsStringLiteral, IsNumericLiteral } from 'type-fest';
+import { I as If } from './if-D4QIikQ1.cjs';
+
+type StringToPath<S> = If<IsStringLiteral<S>, StringToPathImpl<S>, Array<string | number>>;
+type StringToPathImpl<S> = S extends `${infer Head}['${infer Quoted}']${infer Tail}` ? [...StringToPath<Head>, Quoted, ...StringToPath<Tail>] : S extends `${infer Head}["${infer DoubleQuoted}"]${infer Tail}` ? [...StringToPath<Head>, DoubleQuoted, ...StringToPath<Tail>] : S extends `${infer Head}[${infer Unquoted}]${infer Tail}` ? [
+    ...StringToPath<Head>,
+    ...StringToPath<Unquoted>,
+    ...StringToPath<Tail>
+] : S extends `${infer Head}.${infer Tail}` ? [...StringToPath<Head>, ...StringToPath<Tail>] : '' extends S ? [] : S extends `${infer N extends number}` ? [
+    If<IsNumericLiteral<N>, N, S>
+] : [S];
 /**
- * Converts a path string to an array of string keys (including array index
- * access keys).
+ * A utility to allow JSONPath-like strings to be used in other utilities which
+ * take an array of path segments as input (e.g. `pathOr`, `setPath`, etc...).
+ * The main purpose of this utility is to act as a bridge between the runtime
+ * implementation that converts the path to an array, and the type-system that
+ * parses the path string **type** into an array **type**. This type allows us
+ * to return fine-grained types and to enforce correctness at the type-level.
  *
- * ! IMPORTANT: Attempting to pass a simple `string` type will result in the
- * result being inferred as `never`. This is intentional to help with type-
- * safety as this function is primarily intended to help with other "object path
- * access" functions like `pathOr` or `setPath`.
+ * We **discourage** using this utility for new code. This utility is for legacy
+ * code that already contains path strings (which are accepted by Lodash). We
+ * strongly recommend using *path arrays* instead as they provide better
+ * developer experience via significantly faster type-checking, fine-grained
+ * error messages, and automatic typeahead suggestions for each segment of the
+ * path.
  *
- * @param path - A string path.
+ * There are a bunch of limitations to this utility derived from the
+ * limitations of the type itself, these are usually edge-cases around deeply
+ * nested paths, escaping, whitespaces, and empty segments. This is true even
+ * in cases where the runtime implementation can better handle them, this is
+ * intentional. See the tests for this utility for more details and the
+ * expected outputs*.
  *
+ * @param path - A string path.
  * @signature
- *    P.stringToPathArray(path)
+ *   P.stringToPath(path)
  * @example
- *    P.stringToPathArray('a.b[0].c') // => ['a', 'b', '0', 'c']
+ *   P.stringToPath('a.b[0].c') // => ['a', 'b', 0, 'c']
  * @dataFirst
  * @category Utility
  */
-declare function stringToPath<Path extends string>(path: Path): StringToPath<Path>;
+declare function stringToPath<const Path extends string>(path: Path): StringToPath<Path>;
 
 export { stringToPath };

package/dist/string-to-path.d.ts

@@ -1,22 +1,44 @@
-type StringToPath<T extends string> = string extends T ? never : T extends '' ? [] : T extends `${infer Head}[${infer Nest}].${infer Tail}` ? [...StringToPath<Head>, Nest, ...StringToPath<Tail>] : T extends `${infer Head}[${infer Nest}]` ? [...StringToPath<Head>, Nest] : T extends `${infer Head}.${infer Tail}` ? [...StringToPath<Head>, ...StringToPath<Tail>] : [T];
+import { IsStringLiteral, IsNumericLiteral } from 'type-fest';
+import { I as If } from './if-D4QIikQ1.js';
+
+type StringToPath<S> = If<IsStringLiteral<S>, StringToPathImpl<S>, Array<string | number>>;
+type StringToPathImpl<S> = S extends `${infer Head}['${infer Quoted}']${infer Tail}` ? [...StringToPath<Head>, Quoted, ...StringToPath<Tail>] : S extends `${infer Head}["${infer DoubleQuoted}"]${infer Tail}` ? [...StringToPath<Head>, DoubleQuoted, ...StringToPath<Tail>] : S extends `${infer Head}[${infer Unquoted}]${infer Tail}` ? [
+    ...StringToPath<Head>,
+    ...StringToPath<Unquoted>,
+    ...StringToPath<Tail>
+] : S extends `${infer Head}.${infer Tail}` ? [...StringToPath<Head>, ...StringToPath<Tail>] : '' extends S ? [] : S extends `${infer N extends number}` ? [
+    If<IsNumericLiteral<N>, N, S>
+] : [S];
 /**
- * Converts a path string to an array of string keys (including array index
- * access keys).
+ * A utility to allow JSONPath-like strings to be used in other utilities which
+ * take an array of path segments as input (e.g. `pathOr`, `setPath`, etc...).
+ * The main purpose of this utility is to act as a bridge between the runtime
+ * implementation that converts the path to an array, and the type-system that
+ * parses the path string **type** into an array **type**. This type allows us
+ * to return fine-grained types and to enforce correctness at the type-level.
  *
- * ! IMPORTANT: Attempting to pass a simple `string` type will result in the
- * result being inferred as `never`. This is intentional to help with type-
- * safety as this function is primarily intended to help with other "object path
- * access" functions like `pathOr` or `setPath`.
+ * We **discourage** using this utility for new code. This utility is for legacy
+ * code that already contains path strings (which are accepted by Lodash). We
+ * strongly recommend using *path arrays* instead as they provide better
+ * developer experience via significantly faster type-checking, fine-grained
+ * error messages, and automatic typeahead suggestions for each segment of the
+ * path.
  *
- * @param path - A string path.
+ * There are a bunch of limitations to this utility derived from the
+ * limitations of the type itself, these are usually edge-cases around deeply
+ * nested paths, escaping, whitespaces, and empty segments. This is true even
+ * in cases where the runtime implementation can better handle them, this is
+ * intentional. See the tests for this utility for more details and the
+ * expected outputs*.
  *
+ * @param path - A string path.
  * @signature
- *    P.stringToPathArray(path)
+ *   P.stringToPath(path)
  * @example
- *    P.stringToPathArray('a.b[0].c') // => ['a', 'b', '0', 'c']
+ *   P.stringToPath('a.b[0].c') // => ['a', 'b', 0, 'c']
  * @dataFirst
  * @category Utility
  */
-declare function stringToPath<Path extends string>(path: Path): StringToPath<Path>;
+declare function stringToPath<const Path extends string>(path: Path): StringToPath<Path>;
 
 export { stringToPath };