@vinicunca/perkakas 1.6.0 → 1.7.1

package/dist/prop.d.cts

@@ -1,29 +1,134 @@
+import { IsNumericLiteral, ArrayIndices, KeysOfUnion } from 'type-fest';
+import { C as ClampedIntegerSubtract } from './clamped-integer-subtract-DZ7rsJE4.cjs';
+import { I as IntRangeInclusive } from './int-range-inclusive-Cn-qsrAN.cjs';
+import { I as IterableContainer } from './iterable-container-BTpDVdNc.cjs';
+import { T as TupleParts } from './tuple-parts-v6av7LMU.cjs';
+import './perkakas-type-error-8wPb8T2y.cjs';
+
+/**
+ * The type for the I'th element in the tuple T. This type corrects some of the
+ * issues with TypeScript's built-in tuple accessor inference `T[I]` for arrays
+ * and tuples with fixed suffixes, and for primitive indices where we don't know
+ * if the index is out of bounds.
+ */
+type ArrayAt<T extends IterableContainer, I extends keyof T> = IsNumericLiteral<I> extends true ? I extends unknown ? [
+    ...TupleParts<T>['required'],
+    ...TupleParts<T>['optional']
+] extends infer Prefix extends ReadonlyArray<unknown> ? HasIndex<Prefix, I> extends true ? T[I] : TupleParts<T>['item'] | (ClampedIntegerSubtract<I, Prefix['length']> extends infer SuffixIndex extends number ? HasIndex<TupleParts<T>['suffix'], SuffixIndex> extends true ? TupleParts<T>['suffix'][IntRangeInclusive<0, SuffixIndex>] : TupleParts<T>['suffix'][number] | undefined : never) : never : never : T[number] | undefined;
+type HasIndex<T extends ReadonlyArray<unknown>, I> = I extends ArrayIndices<T> ? true : false;
+
+type NoInfer<T> = T extends infer U ? U : never;
+
+type KeysDeep<T, Path extends ReadonlyArray<unknown>> = KeysOfUnion<PropDeep<T, Path>>;
+type PropDeep<T, Path extends ReadonlyArray<unknown>> = Path extends readonly [
+    infer Key,
+    ...infer Rest
+] ? PropDeep<Prop<T, Key>, Rest> : T;
+type Prop<T, Key> = T extends unknown ? Key extends keyof T ? T extends ReadonlyArray<unknown> ? ArrayAt<T, Key> : T[Key] : undefined : never;
+type NonPropertyKey = object | null | undefined;
 /**
- * Gets the value of the given property.
+ * Gets the value of the given property from an object. Nested properties can
+ * be accessed by providing a variadic array of keys that define the path from
+ * the root to the desired property. Arrays can be accessed by using numeric
+ * keys. Unions and optional properties are handled gracefully by returning
+ * `undefined` early for any non-existing property on the path. Paths are
+ * validated against the object type to provide stronger type safety, better
+ * compile-time errors, and to enable autocompletion in IDEs.
  *
- * @param data - The object to extract the prop from.
- * @param key - The key of the property to extract.
+ * @param data - The object or array to access.
+ * @param key - The key(s) for the property to extract.
  * @signature
- *   P.prop(data, key);
+ *   P.prop(data, ...keys);
  * @example
- *   P.prop({ foo: 'bar' }, 'foo'); // => 'bar'
+ *   P.prop({ foo: { bar: 'baz' } }, 'foo'); //=> { bar: 'baz' }
+ *   P.prop({ foo: { bar: 'baz' } }, 'foo', 'bar'); //=> 'baz'
+ *   P.prop(["cat", "dog"], 1); //=> 'dog'
  * @dataFirst
  * @category Object
  */
-declare function prop<T, K extends keyof T>(data: T, key: K): T[K];
+declare function prop<T extends NonPropertyKey, Key extends KeysDeep<T, []>>(data: T, key: Key): NoInfer<Prop<T, Key>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>>(data: T, key0: Key0, key1: Key1): NoInfer<PropDeep<T, [Key0, Key1]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>>(data: T, key0: Key0, key1: Key1, key2: Key2): NoInfer<PropDeep<T, [Key0, Key1, Key2]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>>(data: T, key0: Key0, key1: Key1, key2: Key2, key3: Key3): NoInfer<PropDeep<T, [Key0, Key1, Key2, Key3]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>, Key4 extends KeysDeep<T, [Key0, Key1, Key2, Key3]>>(data: T, key0: Key0, key1: Key1, key2: Key2, key3: Key3, key4: Key4): NoInfer<PropDeep<T, [Key0, Key1, Key2, Key3, Key4]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>, Key4 extends KeysDeep<T, [Key0, Key1, Key2, Key3]>, Key5 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4]>>(data: T, key0: Key0, key1: Key1, key2: Key2, key3: Key3, key4: Key4, key5: Key5): NoInfer<PropDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>, Key4 extends KeysDeep<T, [Key0, Key1, Key2, Key3]>, Key5 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4]>, Key6 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5]>>(data: T, key0: Key0, key1: Key1, key2: Key2, key3: Key3, key4: Key4, key5: Key5, key6: Key6): NoInfer<PropDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>, Key4 extends KeysDeep<T, [Key0, Key1, Key2, Key3]>, Key5 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4]>, Key6 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5]>, Key7 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6]>>(data: T, key0: Key0, key1: Key1, key2: Key2, key3: Key3, key4: Key4, key5: Key5, key6: Key6, key7: Key7): NoInfer<PropDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6, Key7]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>, Key4 extends KeysDeep<T, [Key0, Key1, Key2, Key3]>, Key5 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4]>, Key6 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5]>, Key7 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6]>, Key8 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6, Key7]>>(data: T, key0: Key0, key1: Key1, key2: Key2, key3: Key3, key4: Key4, key5: Key5, key6: Key6, key7: Key7, key8: Key8): NoInfer<PropDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6, Key7, Key8]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>, Key4 extends KeysDeep<T, [Key0, Key1, Key2, Key3]>, Key5 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4]>, Key6 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5]>, Key7 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6]>, Key8 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6, Key7]>, Key9 extends KeysDeep<T, [
+    Key0,
+    Key1,
+    Key2,
+    Key3,
+    Key4,
+    Key5,
+    Key6,
+    Key7,
+    Key8
+]>, AdditionalKeys extends ReadonlyArray<PropertyKey> = []>(data: T, key0: Key0, key1: Key1, key2: Key2, key3: Key3, key4: Key4, key5: Key5, key6: Key6, key7: Key7, key8: Key8, key9: Key9, ...additionalKeys: AdditionalKeys): NoInfer<PropDeep<T, [
+    Key0,
+    Key1,
+    Key2,
+    Key3,
+    Key4,
+    Key5,
+    Key6,
+    Key7,
+    Key8,
+    Key9,
+    ...AdditionalKeys
+]>>;
 /**
- * Gets the value of the given property.
+ * Gets the value of the given property from an object. Nested properties can
+ * be accessed by providing a variadic array of keys that define the path from
+ * the root to the desired property. Arrays can be accessed by using numeric
+ * keys. Unions and optional properties are handled gracefully by returning
+ * `undefined` early for any non-existing property on the path. Paths are
+ * validated against the object type to provide stronger type safety, better
+ * compile-time errors, and to enable autocompletion in IDEs.
  *
- * @param key - The key of the property to extract.
+ * @param key - The key(s) for the property to extract.
  * @signature
- *   P.prop(key)(data);
+ *   P.prop(...keys)(data);
  * @example
- *    P.pipe({foo: 'bar'}, P.prop('foo')) // => 'bar'
+ *   P.pipe({ foo: { bar: 'baz' } }, P.prop('foo')); //=> { bar: 'baz' }
+ *   P.pipe({ foo: { bar: 'baz' } }, P.prop('foo', 'bar')); //=> 'baz'
+ *   P.pipe(["cat", "dog"], P.prop(1)); //=> 'dog'
  * @dataLast
  * @category Object
  */
-declare function prop<T, K extends keyof T>(key: K): (data: T) => T[K];
+declare function prop<T extends NonPropertyKey, Key extends KeysOfUnion<T>>(key: Key): (data: T) => NoInfer<Prop<T, Key>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>>(key0: Key0, key1: Key1): (data: T) => NoInfer<PropDeep<T, [Key0, Key1]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>>(key0: Key0, key1: Key1, key2: Key2): (data: T) => NoInfer<PropDeep<T, [Key0, Key1, Key2]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>>(key0: Key0, key1: Key1, key2: Key2, key3: Key3): (data: T) => NoInfer<PropDeep<T, [Key0, Key1, Key2, Key3]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>, Key4 extends KeysDeep<T, [Key0, Key1, Key2, Key3]>>(key0: Key0, key1: Key1, key2: Key2, key3: Key3, key4: Key4): (data: T) => NoInfer<PropDeep<T, [Key0, Key1, Key2, Key3, Key4]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>, Key4 extends KeysDeep<T, [Key0, Key1, Key2, Key3]>, Key5 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4]>>(key0: Key0, key1: Key1, key2: Key2, key3: Key3, key4: Key4, key5: Key5): (data: T) => NoInfer<PropDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>, Key4 extends KeysDeep<T, [Key0, Key1, Key2, Key3]>, Key5 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4]>, Key6 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5]>>(key0: Key0, key1: Key1, key2: Key2, key3: Key3, key4: Key4, key5: Key5, key6: Key6): (data: T) => NoInfer<PropDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>, Key4 extends KeysDeep<T, [Key0, Key1, Key2, Key3]>, Key5 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4]>, Key6 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5]>, Key7 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6]>>(key0: Key0, key1: Key1, key2: Key2, key3: Key3, key4: Key4, key5: Key5, key6: Key6, key7: Key7): (data: T) => NoInfer<PropDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6, Key7]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>, Key4 extends KeysDeep<T, [Key0, Key1, Key2, Key3]>, Key5 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4]>, Key6 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5]>, Key7 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6]>, Key8 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6, Key7]>>(key0: Key0, key1: Key1, key2: Key2, key3: Key3, key4: Key4, key5: Key5, key6: Key6, key7: Key7, key8: Key8): (data: T) => NoInfer<PropDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6, Key7, Key8]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>, Key4 extends KeysDeep<T, [Key0, Key1, Key2, Key3]>, Key5 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4]>, Key6 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5]>, Key7 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6]>, Key8 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6, Key7]>, Key9 extends KeysDeep<T, [
+    Key0,
+    Key1,
+    Key2,
+    Key3,
+    Key4,
+    Key5,
+    Key6,
+    Key7,
+    Key8
+]>, AdditionalKeys extends ReadonlyArray<PropertyKey> = []>(key0: Key0, key1: Key1, key2: Key2, key3: Key3, key4: Key4, key5: Key5, key6: Key6, key7: Key7, key8: Key8, key9: Key9, ...additionalKeys: AdditionalKeys): (data: T) => NoInfer<PropDeep<T, [
+    Key0,
+    Key1,
+    Key2,
+    Key3,
+    Key4,
+    Key5,
+    Key6,
+    Key7,
+    Key8,
+    Key9,
+    ...AdditionalKeys
+]>>;
 declare function prop<K extends PropertyKey>(key: K): <T extends Partial<Record<K, unknown>>>(data: T) => T[K];
-declare function propImplementation<T, K extends keyof T>(data: T, key: K): T[K];
 
-export { prop, propImplementation };
+export { prop };

package/dist/prop.d.ts

@@ -1,29 +1,134 @@
+import { IsNumericLiteral, ArrayIndices, KeysOfUnion } from 'type-fest';
+import { C as ClampedIntegerSubtract } from './clamped-integer-subtract-DZ7rsJE4.js';
+import { I as IntRangeInclusive } from './int-range-inclusive-Cn-qsrAN.js';
+import { I as IterableContainer } from './iterable-container-BTpDVdNc.js';
+import { T as TupleParts } from './tuple-parts-BTivqbtT.js';
+import './perkakas-type-error-8wPb8T2y.js';
+
+/**
+ * The type for the I'th element in the tuple T. This type corrects some of the
+ * issues with TypeScript's built-in tuple accessor inference `T[I]` for arrays
+ * and tuples with fixed suffixes, and for primitive indices where we don't know
+ * if the index is out of bounds.
+ */
+type ArrayAt<T extends IterableContainer, I extends keyof T> = IsNumericLiteral<I> extends true ? I extends unknown ? [
+    ...TupleParts<T>['required'],
+    ...TupleParts<T>['optional']
+] extends infer Prefix extends ReadonlyArray<unknown> ? HasIndex<Prefix, I> extends true ? T[I] : TupleParts<T>['item'] | (ClampedIntegerSubtract<I, Prefix['length']> extends infer SuffixIndex extends number ? HasIndex<TupleParts<T>['suffix'], SuffixIndex> extends true ? TupleParts<T>['suffix'][IntRangeInclusive<0, SuffixIndex>] : TupleParts<T>['suffix'][number] | undefined : never) : never : never : T[number] | undefined;
+type HasIndex<T extends ReadonlyArray<unknown>, I> = I extends ArrayIndices<T> ? true : false;
+
+type NoInfer<T> = T extends infer U ? U : never;
+
+type KeysDeep<T, Path extends ReadonlyArray<unknown>> = KeysOfUnion<PropDeep<T, Path>>;
+type PropDeep<T, Path extends ReadonlyArray<unknown>> = Path extends readonly [
+    infer Key,
+    ...infer Rest
+] ? PropDeep<Prop<T, Key>, Rest> : T;
+type Prop<T, Key> = T extends unknown ? Key extends keyof T ? T extends ReadonlyArray<unknown> ? ArrayAt<T, Key> : T[Key] : undefined : never;
+type NonPropertyKey = object | null | undefined;
 /**
- * Gets the value of the given property.
+ * Gets the value of the given property from an object. Nested properties can
+ * be accessed by providing a variadic array of keys that define the path from
+ * the root to the desired property. Arrays can be accessed by using numeric
+ * keys. Unions and optional properties are handled gracefully by returning
+ * `undefined` early for any non-existing property on the path. Paths are
+ * validated against the object type to provide stronger type safety, better
+ * compile-time errors, and to enable autocompletion in IDEs.
  *
- * @param data - The object to extract the prop from.
- * @param key - The key of the property to extract.
+ * @param data - The object or array to access.
+ * @param key - The key(s) for the property to extract.
  * @signature
- *   P.prop(data, key);
+ *   P.prop(data, ...keys);
  * @example
- *   P.prop({ foo: 'bar' }, 'foo'); // => 'bar'
+ *   P.prop({ foo: { bar: 'baz' } }, 'foo'); //=> { bar: 'baz' }
+ *   P.prop({ foo: { bar: 'baz' } }, 'foo', 'bar'); //=> 'baz'
+ *   P.prop(["cat", "dog"], 1); //=> 'dog'
  * @dataFirst
  * @category Object
  */
-declare function prop<T, K extends keyof T>(data: T, key: K): T[K];
+declare function prop<T extends NonPropertyKey, Key extends KeysDeep<T, []>>(data: T, key: Key): NoInfer<Prop<T, Key>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>>(data: T, key0: Key0, key1: Key1): NoInfer<PropDeep<T, [Key0, Key1]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>>(data: T, key0: Key0, key1: Key1, key2: Key2): NoInfer<PropDeep<T, [Key0, Key1, Key2]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>>(data: T, key0: Key0, key1: Key1, key2: Key2, key3: Key3): NoInfer<PropDeep<T, [Key0, Key1, Key2, Key3]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>, Key4 extends KeysDeep<T, [Key0, Key1, Key2, Key3]>>(data: T, key0: Key0, key1: Key1, key2: Key2, key3: Key3, key4: Key4): NoInfer<PropDeep<T, [Key0, Key1, Key2, Key3, Key4]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>, Key4 extends KeysDeep<T, [Key0, Key1, Key2, Key3]>, Key5 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4]>>(data: T, key0: Key0, key1: Key1, key2: Key2, key3: Key3, key4: Key4, key5: Key5): NoInfer<PropDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>, Key4 extends KeysDeep<T, [Key0, Key1, Key2, Key3]>, Key5 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4]>, Key6 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5]>>(data: T, key0: Key0, key1: Key1, key2: Key2, key3: Key3, key4: Key4, key5: Key5, key6: Key6): NoInfer<PropDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>, Key4 extends KeysDeep<T, [Key0, Key1, Key2, Key3]>, Key5 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4]>, Key6 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5]>, Key7 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6]>>(data: T, key0: Key0, key1: Key1, key2: Key2, key3: Key3, key4: Key4, key5: Key5, key6: Key6, key7: Key7): NoInfer<PropDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6, Key7]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>, Key4 extends KeysDeep<T, [Key0, Key1, Key2, Key3]>, Key5 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4]>, Key6 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5]>, Key7 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6]>, Key8 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6, Key7]>>(data: T, key0: Key0, key1: Key1, key2: Key2, key3: Key3, key4: Key4, key5: Key5, key6: Key6, key7: Key7, key8: Key8): NoInfer<PropDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6, Key7, Key8]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>, Key4 extends KeysDeep<T, [Key0, Key1, Key2, Key3]>, Key5 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4]>, Key6 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5]>, Key7 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6]>, Key8 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6, Key7]>, Key9 extends KeysDeep<T, [
+    Key0,
+    Key1,
+    Key2,
+    Key3,
+    Key4,
+    Key5,
+    Key6,
+    Key7,
+    Key8
+]>, AdditionalKeys extends ReadonlyArray<PropertyKey> = []>(data: T, key0: Key0, key1: Key1, key2: Key2, key3: Key3, key4: Key4, key5: Key5, key6: Key6, key7: Key7, key8: Key8, key9: Key9, ...additionalKeys: AdditionalKeys): NoInfer<PropDeep<T, [
+    Key0,
+    Key1,
+    Key2,
+    Key3,
+    Key4,
+    Key5,
+    Key6,
+    Key7,
+    Key8,
+    Key9,
+    ...AdditionalKeys
+]>>;
 /**
- * Gets the value of the given property.
+ * Gets the value of the given property from an object. Nested properties can
+ * be accessed by providing a variadic array of keys that define the path from
+ * the root to the desired property. Arrays can be accessed by using numeric
+ * keys. Unions and optional properties are handled gracefully by returning
+ * `undefined` early for any non-existing property on the path. Paths are
+ * validated against the object type to provide stronger type safety, better
+ * compile-time errors, and to enable autocompletion in IDEs.
  *
- * @param key - The key of the property to extract.
+ * @param key - The key(s) for the property to extract.
  * @signature
- *   P.prop(key)(data);
+ *   P.prop(...keys)(data);
  * @example
- *    P.pipe({foo: 'bar'}, P.prop('foo')) // => 'bar'
+ *   P.pipe({ foo: { bar: 'baz' } }, P.prop('foo')); //=> { bar: 'baz' }
+ *   P.pipe({ foo: { bar: 'baz' } }, P.prop('foo', 'bar')); //=> 'baz'
+ *   P.pipe(["cat", "dog"], P.prop(1)); //=> 'dog'
  * @dataLast
  * @category Object
  */
-declare function prop<T, K extends keyof T>(key: K): (data: T) => T[K];
+declare function prop<T extends NonPropertyKey, Key extends KeysOfUnion<T>>(key: Key): (data: T) => NoInfer<Prop<T, Key>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>>(key0: Key0, key1: Key1): (data: T) => NoInfer<PropDeep<T, [Key0, Key1]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>>(key0: Key0, key1: Key1, key2: Key2): (data: T) => NoInfer<PropDeep<T, [Key0, Key1, Key2]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>>(key0: Key0, key1: Key1, key2: Key2, key3: Key3): (data: T) => NoInfer<PropDeep<T, [Key0, Key1, Key2, Key3]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>, Key4 extends KeysDeep<T, [Key0, Key1, Key2, Key3]>>(key0: Key0, key1: Key1, key2: Key2, key3: Key3, key4: Key4): (data: T) => NoInfer<PropDeep<T, [Key0, Key1, Key2, Key3, Key4]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>, Key4 extends KeysDeep<T, [Key0, Key1, Key2, Key3]>, Key5 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4]>>(key0: Key0, key1: Key1, key2: Key2, key3: Key3, key4: Key4, key5: Key5): (data: T) => NoInfer<PropDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>, Key4 extends KeysDeep<T, [Key0, Key1, Key2, Key3]>, Key5 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4]>, Key6 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5]>>(key0: Key0, key1: Key1, key2: Key2, key3: Key3, key4: Key4, key5: Key5, key6: Key6): (data: T) => NoInfer<PropDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>, Key4 extends KeysDeep<T, [Key0, Key1, Key2, Key3]>, Key5 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4]>, Key6 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5]>, Key7 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6]>>(key0: Key0, key1: Key1, key2: Key2, key3: Key3, key4: Key4, key5: Key5, key6: Key6, key7: Key7): (data: T) => NoInfer<PropDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6, Key7]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>, Key4 extends KeysDeep<T, [Key0, Key1, Key2, Key3]>, Key5 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4]>, Key6 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5]>, Key7 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6]>, Key8 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6, Key7]>>(key0: Key0, key1: Key1, key2: Key2, key3: Key3, key4: Key4, key5: Key5, key6: Key6, key7: Key7, key8: Key8): (data: T) => NoInfer<PropDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6, Key7, Key8]>>;
+declare function prop<T extends NonPropertyKey, Key0 extends KeysDeep<T, []>, Key1 extends KeysDeep<T, [Key0]>, Key2 extends KeysDeep<T, [Key0, Key1]>, Key3 extends KeysDeep<T, [Key0, Key1, Key2]>, Key4 extends KeysDeep<T, [Key0, Key1, Key2, Key3]>, Key5 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4]>, Key6 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5]>, Key7 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6]>, Key8 extends KeysDeep<T, [Key0, Key1, Key2, Key3, Key4, Key5, Key6, Key7]>, Key9 extends KeysDeep<T, [
+    Key0,
+    Key1,
+    Key2,
+    Key3,
+    Key4,
+    Key5,
+    Key6,
+    Key7,
+    Key8
+]>, AdditionalKeys extends ReadonlyArray<PropertyKey> = []>(key0: Key0, key1: Key1, key2: Key2, key3: Key3, key4: Key4, key5: Key5, key6: Key6, key7: Key7, key8: Key8, key9: Key9, ...additionalKeys: AdditionalKeys): (data: T) => NoInfer<PropDeep<T, [
+    Key0,
+    Key1,
+    Key2,
+    Key3,
+    Key4,
+    Key5,
+    Key6,
+    Key7,
+    Key8,
+    Key9,
+    ...AdditionalKeys
+]>>;
 declare function prop<K extends PropertyKey>(key: K): <T extends Partial<Record<K, unknown>>>(data: T) => T[K];
-declare function propImplementation<T, K extends keyof T>(data: T, key: K): T[K];
 
-export { prop, propImplementation };
+export { prop };

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}from"./chunk-RZBBV6PK.js";import"./chunk-EK7ODJWE.js";export{a as prop};

package/dist/pull-object.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkFGMSPUSFcjs = require('./chunk-FGMSPUSF.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');exports.pullObject = _chunkFGMSPUSFcjs.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,6 +1,6 @@
-import { B as BoundedPartial } from './bounded-partial-wqR8ceNQ.cjs';
+import { B as BoundedPartial } from './bounded-partial-BhnecV3P.cjs';
 import { I as IterableContainer } from './iterable-container-BTpDVdNc.cjs';
-import './if-bounded-record-Drd4UbBU.cjs';
+import './is-bounded-record-C9WAwfA8.cjs';
 import 'type-fest';
 
 /**

package/dist/pull-object.d.ts

@@ -1,6 +1,6 @@
-import { B as BoundedPartial } from './bounded-partial-CJjczH6j.js';
+import { B as BoundedPartial } from './bounded-partial-B15MLSAS.js';
 import { I as IterableContainer } from './iterable-container-BTpDVdNc.js';
-import './if-bounded-record-Drd4UbBU.js';
+import './is-bounded-record-C9WAwfA8.js';
 import 'type-fest';
 
 /**

package/dist/pull-object.js

@@ -1 +1 @@
-import{a}from"./chunk-B6SBIS6W.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 _chunkALP5JUXXcjs = require('./chunk-ALP5JUXX.cjs');require('./chunk-XR72I63W.cjs');require('./chunk-GZJMERDJ.cjs');require('./chunk-MBGSSEZN.cjs');exports.sample = _chunkALP5JUXXcjs.a;

package/dist/sample.d.cts

@@ -1,11 +1,35 @@
+import { Or, IsEqual, IsNever, NonNegativeInteger, FixedLengthArray, Writable } from 'type-fest';
+import { C as CoercedArray } from './coerced-array-DRz3tqda.cjs';
 import { I as IterableContainer } from './iterable-container-BTpDVdNc.cjs';
+import { N as NTuple } from './n-tuple-5jljrt4c.cjs';
+import { P as PartialArray } from './partial-array-Vnf1fBtl.cjs';
+import { T as TupleParts } from './tuple-parts-v6av7LMU.cjs';
+import './perkakas-type-error-8wPb8T2y.cjs';
 
-type Sampled<T extends IterableContainer, N extends number> = number extends N ? SampledGeneric<T> : undefined extends T[N] ? T : SampledLiteral<T, N>;
-type SampledGeneric<T extends IterableContainer> = T[number] extends never ? T : T extends readonly [infer First, ...infer Rest] ? [First, ...SampledGeneric<Rest>] | SampledGeneric<Rest> : Array<T[number]>;
-type SampledLiteral<T extends IterableContainer, N extends number, Iteration extends Array<unknown> = []> = Iteration['length'] extends N ? [] : T extends readonly [infer First, ...infer Tail] ? [
-    First | Tail[number],
-    ...SampledLiteral<Tail, N, [unknown, ...Iteration]>
-] : T extends readonly [...infer Head, infer Last] ? [...SampledLiteral<Head, N, [unknown, ...Iteration]>, Last] : [T[number], ...SampledLiteral<T, N, [unknown, ...Iteration]>] | SampledLiteral<T, N, [unknown, ...Iteration]>;
+type Sampled<T extends IterableContainer, N extends number> = Or<IsEqual<N, 0>, IsEqual<T['length'], 0>> extends true ? [] : IsNever<NonNegativeInteger<N>> extends true ? SampledPrimitive<T> : IsLongerThan<T, N> extends true ? SampledLiteral<T, N> : Writable<T>;
+/**
+ * When N is not a non-negative integer **literal** we can't use it in our
+ * reconstructing logic so we fallback to a simpler definition of the output of
+ * sample, which is any sub-tuple shape of T, of **any length**.
+ */
+type SampledPrimitive<T extends IterableContainer> = [
+    ...FixedSubTuples<TupleParts<T>['required']>,
+    ...PartialArray<FixedSubTuples<TupleParts<T>['optional']>>,
+    ...CoercedArray<TupleParts<T>['item']>,
+    ...FixedSubTuples<TupleParts<T>['suffix']>
+];
+/**
+ * Knowing N is a non-negative literal integer we can construct all sub-tuples
+ * of T that are exactly N elements long.
+ */
+type SampledLiteral<T extends IterableContainer, N extends number> = Extract<FixedSubTuples<[
+    ...TupleParts<T>['required'],
+    ...(IsNever<TupleParts<T>['item']> extends true ? [] : NTuple<TupleParts<T>['item'], N>),
+    ...TupleParts<T>['suffix']
+]>, FixedLengthArray<unknown, N>> | SubSampled<TupleParts<T>['required'], TupleParts<T>['item'], TupleParts<T>['suffix'], N>;
+type SubSampled<Prefix extends ReadonlyArray<unknown>, Item, Suffix extends ReadonlyArray<unknown>, N extends number> = IsLongerThan<[...Prefix, ...Suffix], N> extends true ? never : [...Prefix, ...Suffix]['length'] extends N ? never : [...Prefix, ...Suffix] | SubSampled<[...Prefix, Item], Item, Suffix, N>;
+type IsLongerThan<T extends ReadonlyArray<unknown>, N extends number> = IsEqual<T[N], undefined> extends true ? false : true;
+type FixedSubTuples<T> = T extends readonly [infer Head, ...infer Rest] ? FixedSubTuples<Rest> | [Head, ...FixedSubTuples<Rest>] : [];
 /**
  * Returns a random subset of size `sampleSize` from `array`.
  *
@@ -27,7 +51,7 @@ type SampledLiteral<T extends IterableContainer, N extends number, Iteration ext
  * @dataFirst
  * @category Array
  */
-declare function sample<T extends IterableContainer, N extends number = number>(data: T, sampleSize: N): Sampled<T, N>;
+declare function sample<const T extends IterableContainer, N extends number = number>(data: T, sampleSize: N): Sampled<T, N>;
 /**
  * Returns a random subset of size `sampleSize` from `array`.
  *
@@ -48,6 +72,6 @@ declare function sample<T extends IterableContainer, N extends number = number>(
  * @dataLast
  * @category Array
  */
-declare function sample<T extends IterableContainer, N extends number = number>(sampleSize: N): (data: T) => Sampled<T, N>;
+declare function sample<const T extends IterableContainer, N extends number = number>(sampleSize: N): (data: T) => Sampled<T, N>;
 
 export { sample };

package/dist/sample.d.ts

@@ -1,11 +1,35 @@
+import { Or, IsEqual, IsNever, NonNegativeInteger, FixedLengthArray, Writable } from 'type-fest';
+import { C as CoercedArray } from './coerced-array-DRz3tqda.js';
 import { I as IterableContainer } from './iterable-container-BTpDVdNc.js';
+import { N as NTuple } from './n-tuple-5jljrt4c.js';
+import { P as PartialArray } from './partial-array-Vnf1fBtl.js';
+import { T as TupleParts } from './tuple-parts-BTivqbtT.js';
+import './perkakas-type-error-8wPb8T2y.js';
 
-type Sampled<T extends IterableContainer, N extends number> = number extends N ? SampledGeneric<T> : undefined extends T[N] ? T : SampledLiteral<T, N>;
-type SampledGeneric<T extends IterableContainer> = T[number] extends never ? T : T extends readonly [infer First, ...infer Rest] ? [First, ...SampledGeneric<Rest>] | SampledGeneric<Rest> : Array<T[number]>;
-type SampledLiteral<T extends IterableContainer, N extends number, Iteration extends Array<unknown> = []> = Iteration['length'] extends N ? [] : T extends readonly [infer First, ...infer Tail] ? [
-    First | Tail[number],
-    ...SampledLiteral<Tail, N, [unknown, ...Iteration]>
-] : T extends readonly [...infer Head, infer Last] ? [...SampledLiteral<Head, N, [unknown, ...Iteration]>, Last] : [T[number], ...SampledLiteral<T, N, [unknown, ...Iteration]>] | SampledLiteral<T, N, [unknown, ...Iteration]>;
+type Sampled<T extends IterableContainer, N extends number> = Or<IsEqual<N, 0>, IsEqual<T['length'], 0>> extends true ? [] : IsNever<NonNegativeInteger<N>> extends true ? SampledPrimitive<T> : IsLongerThan<T, N> extends true ? SampledLiteral<T, N> : Writable<T>;
+/**
+ * When N is not a non-negative integer **literal** we can't use it in our
+ * reconstructing logic so we fallback to a simpler definition of the output of
+ * sample, which is any sub-tuple shape of T, of **any length**.
+ */
+type SampledPrimitive<T extends IterableContainer> = [
+    ...FixedSubTuples<TupleParts<T>['required']>,
+    ...PartialArray<FixedSubTuples<TupleParts<T>['optional']>>,
+    ...CoercedArray<TupleParts<T>['item']>,
+    ...FixedSubTuples<TupleParts<T>['suffix']>
+];
+/**
+ * Knowing N is a non-negative literal integer we can construct all sub-tuples
+ * of T that are exactly N elements long.
+ */
+type SampledLiteral<T extends IterableContainer, N extends number> = Extract<FixedSubTuples<[
+    ...TupleParts<T>['required'],
+    ...(IsNever<TupleParts<T>['item']> extends true ? [] : NTuple<TupleParts<T>['item'], N>),
+    ...TupleParts<T>['suffix']
+]>, FixedLengthArray<unknown, N>> | SubSampled<TupleParts<T>['required'], TupleParts<T>['item'], TupleParts<T>['suffix'], N>;
+type SubSampled<Prefix extends ReadonlyArray<unknown>, Item, Suffix extends ReadonlyArray<unknown>, N extends number> = IsLongerThan<[...Prefix, ...Suffix], N> extends true ? never : [...Prefix, ...Suffix]['length'] extends N ? never : [...Prefix, ...Suffix] | SubSampled<[...Prefix, Item], Item, Suffix, N>;
+type IsLongerThan<T extends ReadonlyArray<unknown>, N extends number> = IsEqual<T[N], undefined> extends true ? false : true;
+type FixedSubTuples<T> = T extends readonly [infer Head, ...infer Rest] ? FixedSubTuples<Rest> | [Head, ...FixedSubTuples<Rest>] : [];
 /**
  * Returns a random subset of size `sampleSize` from `array`.
  *
@@ -27,7 +51,7 @@ type SampledLiteral<T extends IterableContainer, N extends number, Iteration ext
  * @dataFirst
  * @category Array
  */
-declare function sample<T extends IterableContainer, N extends number = number>(data: T, sampleSize: N): Sampled<T, N>;
+declare function sample<const T extends IterableContainer, N extends number = number>(data: T, sampleSize: N): Sampled<T, N>;
 /**
  * Returns a random subset of size `sampleSize` from `array`.
  *
@@ -48,6 +72,6 @@ declare function sample<T extends IterableContainer, N extends number = number>(
  * @dataLast
  * @category Array
  */
-declare function sample<T extends IterableContainer, N extends number = number>(sampleSize: N): (data: T) => Sampled<T, N>;
+declare function sample<const T extends IterableContainer, N extends number = number>(sampleSize: N): (data: T) => Sampled<T, N>;
 
 export { sample };

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-4Y6VRHEP.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;