@vinicunca/perkakas 0.0.5 → 0.0.8

package/dist/index.d.cts

@@ -302,7 +302,6 @@ declare namespace difference {
 declare function dropLast<T>(array: ReadonlyArray<T>, n: number): Array<T>;
 /**
  * Removes last `n` elements from the `array`.
- * @param array the target array
  * @param n the number of elements to skip
  * @signature
  *    P.dropLast(n)(array)
@@ -328,7 +327,6 @@ declare function dropLast<T>(n: number): (array: ReadonlyArray<T>) => Array<T>;
 declare function drop<T>(array: ReadonlyArray<T>, n: number): Array<T>;
 /**
  * Removes first `n` elements from the `array`.
- * @param array the target array
  * @param n the number of elements to skip
  * @signature
  *    P.drop(n)(array)
@@ -405,10 +403,9 @@ declare namespace filter {
  * @pipeable
  * @category Array
  */
-declare function findIndex<T>(array: ReadonlyArray<T>, fn: Pred<T, boolean>): number;
+declare function findIndex<T>(items: ReadonlyArray<T>, fn: Pred<T, boolean>): number;
 /**
  * Returns the index of the first element in the array where predicate is true, and -1 otherwise.
- * @param items the array
  * @param fn the predicate
  * @signature
  *    P.findIndex(fn)(items)
@@ -427,7 +424,7 @@ declare function findIndex<T>(array: ReadonlyArray<T>, fn: Pred<T, boolean>): nu
  * @pipeable
  * @category Array
  */
-declare function findIndex<T>(fn: Pred<T, boolean>): (array: ReadonlyArray<T>) => number;
+declare function findIndex<T>(fn: Pred<T, boolean>): (items: ReadonlyArray<T>) => number;
 declare namespace findIndex {
     function indexed<T>(array: ReadonlyArray<T>, fn: PredIndexed<T, boolean>): number;
     function indexed<T>(fn: PredIndexed<T, boolean>): (array: ReadonlyArray<T>) => number;
@@ -475,7 +472,6 @@ declare namespace findIndex {
 declare function findLastIndex<T>(array: ReadonlyArray<T>, fn: Pred<T, boolean>): number;
 /**
  * Returns the index of the last element in the array where predicate is true, and -1 otherwise.
- * @param array the array
  * @param fn the predicate
  * @signature
  *    P.findLastIndex(fn)(items)
@@ -559,7 +555,7 @@ declare namespace findLast {
  * @pipeable
  * @category Array
  */
-declare function find<T>(array: ReadonlyArray<T>, fn: Pred<T, boolean>): T | undefined;
+declare function find<T>(items: ReadonlyArray<T>, fn: Pred<T, boolean>): T | undefined;
 /**
  * Returns the value of the first element in the array where predicate is true, and undefined otherwise.
  * @param fn the predicate
@@ -619,7 +615,7 @@ type FirstOut<T extends IterableContainer> = T extends [] ? undefined : T extend
  *      x => x + 1
  *    ); // => 5
  *
- * @category array
+ * @category Array
  * @pipeable
  */
 declare function first<T extends IterableContainer>(array: Readonly<T>): FirstOut<T>;
@@ -700,7 +696,6 @@ declare namespace flatMapToObj {
 declare function flatMap<T, K>(array: ReadonlyArray<T>, fn: (input: T) => K | Array<K>): Array<K>;
 /**
  * Map each element of an array using a defined callback function and flatten the mapped result.
- * @param array The array to map.
  * @param fn The function mapper.
  * @signature
  *    P.flatMap(fn)(array)
@@ -753,7 +748,6 @@ type Flatten<T> = T extends ReadonlyArray<infer K> ? K : T;
 /**
  * Flattens `array` a single level deep.
  * Note: In `pipe`, use `flatten()` form instead of `flatten`. Otherwise, the inferred type is lost.
-
  * @param items the target array
  * @signature P.flatten(array)
  * @example
@@ -875,7 +869,6 @@ declare namespace groupBy {
 declare function indexBy<T>(array: ReadonlyArray<T>, fn: (item: T) => any): Record<string, T>;
 /**
  * Converts a list of objects into an object indexing the objects by the given key.
- * @param array the array
  * @param fn the indexing function
  * @signature
  *    P.indexBy(fn)(array)
@@ -906,10 +899,9 @@ declare namespace indexBy {
  * @category Array
  * @pipeable
  */
-declare function intersection<T>(source: ReadonlyArray<T>, other: ReadonlyArray<T>): Array<T>;
+declare function intersection<T>(array: ReadonlyArray<T>, other: ReadonlyArray<T>): Array<T>;
 /**
  * Returns a list of elements that exist in both array.
- * @param array the source array
  * @param other the second array
  * @signature
  *    P.intersection(other)(array)
@@ -1007,7 +999,6 @@ declare function join<T extends ReadonlyArray<Joinable> | [], Glue extends strin
  * When called on a tuple and with stricter item types (union of literal values,
  * the result is strictly typed to the tuples shape and it's item types).
  *
- * @param data The array to join
  * @param glue The string to put in between every two elements
  * @signature
  *    P.join(glue)(data)
@@ -1370,7 +1361,7 @@ declare function range(end: number): (start: number) => Array<number>;
 
 /**
  * Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
- * @param array the array to reduce
+ * @param items the array to reduce
  * @param fn the callback function
  * @param initialValue the initial value to use as an accumulator value in the callback function
  * @signature
@@ -1421,7 +1412,6 @@ declare namespace reduce {
 declare function reject<T>(items: ReadonlyArray<T>, fn: Pred<T, boolean>): Array<T>;
 /**
  * Reject the elements of an array that meet the condition specified in a callback function.
- * @param items The array to reject.
  * @param fn the callback function.
  * @signature
  *    P.reject(array, fn)
@@ -1459,7 +1449,6 @@ type IsNoTuple<T> = T extends readonly [unknown, ...Array<unknown>] ? never : T;
 declare function reverse<T extends ReadonlyArray<unknown>>(array: T): Reverse<T>;
 /**
  * Reverses array.
- * @param array the array
  * @signature
  *    P.reverse()(array);
  * @example
@@ -1486,7 +1475,7 @@ type SampledLiteral<T extends IterableContainer, N extends number, Iteration ext
  * If you need to get a shuffled response you can pipe the shuffle function
  * after this one.
  *
- * @param array the array
+ * @param data the array
  * @param sampleSize the number of elements to take
  * @signature
  *    P.sample(array, sampleSize)
@@ -1509,7 +1498,6 @@ declare function sample<T extends IterableContainer, N extends number = number>(
  * If you need to get a shuffled response you can pipe the shuffle function
  * after this one.
  *
- * @param array the array
  * @param sampleSize the number of elements to take
  * @signature
  *    P.sample(sampleSize)(array)
@@ -1622,8 +1610,7 @@ type SortedBy<T extends IterableContainer> = {
  * If the input array is more complex (non-empty array, tuple, etc...) use the
  * strict mode to maintain it's shape.
  *
- * @param sortRule main sort rule
- * @param additionalSortRules subsequent sort rules (these are only relevant when two items are equal based on the previous sort rule)
+ * @param sortRules main sort rule
  * @signature
  *    P.sortBy(sortRule, ...additionalSortRules)(array)
  *    P.sortBy.strict(sortRule, ...additionalSortRules)(array)
@@ -1651,8 +1638,7 @@ declare function sortBy<T>(...sortRules: Readonly<NonEmptyArray<SortRule<T>>>):
  * strict mode to maintain it's shape.
  *
  * @param array the array to sort
- * @param sortRule main sort rule
- * @param additionalSortRules subsequent sort rules (these are only relevant when two items are equal based on the previous sort rule)
+ * @param sortRules main sort rule
  * @signature
  *    P.sortBy(array, sortRule, ...additionalSortRules)
  *    P.sortBy.strict(array, sortRule, ...additionalSortRules)
@@ -1708,7 +1694,6 @@ declare namespace sortBy {
 declare function splitAt<T>(array: ReadonlyArray<T>, index: number): [Array<T>, Array<T>];
 /**
  * Splits a given array at a given index.
- * @param array the array to split
  * @param index the index to split at
  * @signature
  *    P.splitAt(index)(array)
@@ -2134,7 +2119,7 @@ declare function once<T>(fn: () => T): () => T;
 /**
  * Perform left-to-right function composition.
  * @param value The initial value.
- * @param operations the list of operations to apply.
+ * @param arguments the list of operations to apply.
  * @signature P.pipe(data, op1, op2, op3)
  * @example
  *    P.pipe(
@@ -2195,6 +2180,18 @@ declare function pipe<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P>(value: A,
  */
 declare function purry(fn: any, args: IArguments | ReadonlyArray<any>, lazy?: any): any;
 
+/**
+ * Delay execution for a given number of milliseconds.
+ *
+ * @param timeout the number of milliseconds to wait
+ * @signature
+ *   P.sleep(timeout)
+ * @example
+ *  P.sleep(1000) // => Promise<void>
+ * @category Function
+ */
+declare function sleep(timeout: number): Promise<void>;
+
 type DefinitelyArray<T> = Extract<T, Array<any> | ReadonlyArray<any>> extends never ? ReadonlyArray<unknown> : Extract<T, Array<any> | ReadonlyArray<any>>;
 /**
  * A function that checks if the passed parameter is an Array and narrows its type accordingly
@@ -2427,22 +2424,12 @@ declare function isString<T>(data: T | string): data is DefinitelyString<T>;
  */
 declare function isTruthy<T>(data: T): data is Exclude<T, null | undefined | false | '' | 0>;
 
-declare function convertToUnit(str: string | number | null | undefined, unit?: string): string | undefined;
-/**
- * Increase string a value with unit
- *
- */
-declare function increaseWithUnit({ target, delta }: {
-    target: string | number;
-    delta: number;
-}): string | number;
-declare function humanReadableFileSize(bytes: number, base?: 1000 | 1024): string;
-declare function sleep(timeout: number): Promise<void>;
-
 /**
  * Clamp the given value within the inclusive min and max bounds.
  * @param value the number
  * @param limits the bounds limits
+ * @param limits.min the minimal bounds limits
+ * @param limits.max the maximal bounds limits
  * @signature
  *    P.clamp(value, { min, max });
  * @example
@@ -2458,8 +2445,9 @@ declare function clamp(value: number, limits: {
 }): number;
 /**
  * Clamp the given value within the inclusive min and max bounds.
- * @param value the number
  * @param limits the bounds limits
+ * @param limits.min the minimal bounds limits
+ * @param limits.max the maximal bounds limits
  * @signature
  *    P.clamp({ min, max })(value);
  * @example
@@ -2532,7 +2520,6 @@ declare function equals(a: any, b: any): boolean;
  * Returns true if its arguments are equivalent, false otherwise.
  * NOTE: Doesn't handle cyclical data structures.
  * @param a the first object to compare
- * @param b the second object to compare
  * @signature
  *    P.equals(b)(a)
  * @example
@@ -2633,20 +2620,19 @@ type Inverted<T extends object> = T[keyof T] extends PropertyKey ? Record<T[keyo
  * @example
  *    P.invert({ a: "d", b: "e", c: "f" }) // => { d: "a", e: "b", f: "c" }
  * @dataFirst
- * @category object
+ * @category Object
  * @pipeable
  */
 declare function invert<T extends object>(object: T): Inverted<T>;
 /**
  * Returns an object whose keys are values are swapped. If the object contains duplicate values,
  * subsequent values will overwrite previous values.
- * @param object the object
  * @signature
  *    P.invert()(object)
  * @example
  *    P.pipe({ a: "d", b: "e", c: "f" }, P.invert()); // => { d: "a", e: "b", f: "c" }
  * @dataLast
- * @category object
+ * @category Object
  * @pipeable
  */
 declare function invert<T extends object>(): (object: T) => Inverted<T>;
@@ -2771,10 +2757,9 @@ declare function merge<A, B>(b: B): (a: A) => A & B;
 declare function omit<T extends object, K extends keyof T>(data: T, propNames: ReadonlyArray<K>): Omit<T, K>;
 /**
  * Returns a partial copy of an object omitting the keys specified.
- * @param data the object
  * @param propNames the property names
  * @signature
- *    P.omit(names)(obj);
+ *    P.omit(propNames)(obj);
  * @example
  *    P.pipe({ a: 1, b: 2, c: 3, d: 4 }, P.omit(['a', 'd'])) // => { b: 2, c: 3 }
  * @dataLast
@@ -2866,7 +2851,6 @@ declare function pathOr<T, A extends keyof Pathable<T>, B extends keyof Pathable
 declare function pathOr<T, A extends keyof Pathable<T>, B extends keyof Pathable1<T, A>, C extends keyof Pathable2<T, A, B>>(object: T, path: readonly [A, B, C], defaultValue: PathValue3<T, A, B, C>): PathValue3<T, A, B, C>;
 /**
  * Gets the value at `path` of `object`. If the resolved value is `undefined`, the `defaultValue` is returned in its place.
- * @param object the target object
  * @param path the path of the property to get
  * @param defaultValue the default value
  * @signature P.pathOr(array, defaultValue)(object)
@@ -3035,11 +3019,10 @@ type Narrow<A> = Try<A, [], NarrowRaw<A>>;
 declare function setPath<T, TPath extends Array<PropertyKey> & Path<T>>(object: T, path: Narrow<TPath>, value: ValueAtPath<T, TPath>): T;
 /**
  * Sets the value at `path` of `object`. `path` can be an array or a path string.
- * @param obj the target method
  * @param path the property name
  * @param value the value to set
  * @signature
- *    P.setPath(obj, path, value)
+ *    P.setPath(path, value)
  * @example
  *    P.pipe({ a: { b: 1 } }, P.setPath(['a', 'b'], 2)) // { a: { b: 2 } }
  * @dataFirst
@@ -3131,7 +3114,8 @@ declare namespace toPairs {
  * @pipeable
  * @category Object
  */
-declare function values<T>(source: Record<PropertyKey, T> | ArrayLike<T>): Array<T>;
+type Values<T extends object> = T extends ReadonlyArray<unknown> | [] ? Array<T[number]> : Array<T[keyof T]>;
+declare function values<T extends object>(source: T): Values<T>;
 
 type Splitter = '-' | '_' | '/' | '.';
 type LastOfArray<T extends any[]> = T extends [...any, infer R] ? R : never;
@@ -3176,6 +3160,19 @@ declare function toKebabCase<T extends string | readonly string[], Joiner extend
 declare function toSnakeCase(): '';
 declare function toSnakeCase<T extends string | readonly string[]>(string_?: T): JoinByCase<T, '_'>;
 
+/**
+ * Returns human readable file size.
+ * @param bytes the file size in bytes
+ * @param base the base (1000 or 1024)
+ * @signature
+ *  P.humanReadableFileSize(bytes, base)
+ * @example
+ *  P.humanReadableFileSize(1000) // => '1.0 kB'
+ *  P.humanReadableFileSize(2097152, 1024) // => '2.0 Mib'
+ * @category String
+ */
+declare function humanReadableFileSize(bytes: number, base?: 1000 | 1024): string;
+
 /**
  * Random a non-cryptographic random string from characters a-zA-Z0-9.
  * @param length the length of the random string
@@ -3186,6 +3183,18 @@ declare function toSnakeCase<T extends string | readonly string[]>(string_?: T):
  */
 declare function randomString(length: number): string;
 
+/**
+ * Turn any string into a URL/DOM safe string.
+ * @param str the string to slugify
+ * @signature
+ *  P.slugify(str)
+ * @example
+ *  P.slugify('FooBar') // => 'foobar'
+ *  P.slugify('This!-is*&%#@^up!') // => 'this-is-up'
+ * @category String
+ */
+declare function slugify(str: string): string;
+
 /**
  * Converts a path string to an array of keys.
  * @param path a string path
@@ -3218,4 +3227,4 @@ declare function type(val: any): string;
 
 declare const isBrowser: boolean;
 
-export { Joined, KEY_CODES, StringToPath, _setPath, addProp, allPass, anyPass, chunk, clamp, clone, compact, concat, convertToUnit, countBy, createPipe, difference, differenceWith, drop, dropLast, equals, filter, find, findIndex, findLast, findLastIndex, first, flatMap, flatMapToObj, flatten, flattenDeep, forEach, forEachObj, fromPairs, groupBy, humanReadableFileSize, identity, increaseWithUnit, indexBy, intersection, intersectionWith, invert, isArray, isBoolean, isBrowser, isDate, isDefined, isEmpty, isError, isFunction, isNil, isNonNull, isNot, isNumber, isObject, isPromise, isString, isTruthy, isUppercase, join, keys, last, length, map, mapKeys, mapToObj, mapValues, maxBy, meanBy, merge, mergeAll, minBy, noop, omit, omitBy, once, partition, pathOr, pick, pickBy, pipe, prop, purry, randomString, range, reduce, reject, reverse, sample, set, setPath, shuffle, sleep, sort, sortBy, splitAt, splitByCase, splitWhen, stringToPath, sumBy, swapIndices, swapProps, take, takeWhile, toCamelCase, toKebabCase, toLowerFirst, toPairs, toPascalCase, toSnakeCase, toUpperFirst, type, uniq, uniqBy, uniqWith, values, zip, zipObj, zipWith };
+export { Joined, KEY_CODES, StringToPath, _setPath, addProp, allPass, anyPass, chunk, clamp, clone, compact, concat, countBy, createPipe, difference, differenceWith, drop, dropLast, equals, filter, find, findIndex, findLast, findLastIndex, first, flatMap, flatMapToObj, flatten, flattenDeep, forEach, forEachObj, fromPairs, groupBy, humanReadableFileSize, identity, indexBy, intersection, intersectionWith, invert, isArray, isBoolean, isBrowser, isDate, isDefined, isEmpty, isError, isFunction, isNil, isNonNull, isNot, isNumber, isObject, isPromise, isString, isTruthy, isUppercase, join, keys, last, length, map, mapKeys, mapToObj, mapValues, maxBy, meanBy, merge, mergeAll, minBy, noop, omit, omitBy, once, partition, pathOr, pick, pickBy, pipe, prop, purry, randomString, range, reduce, reject, reverse, sample, set, setPath, shuffle, sleep, slugify, sort, sortBy, splitAt, splitByCase, splitWhen, stringToPath, sumBy, swapIndices, swapProps, take, takeWhile, toCamelCase, toKebabCase, toLowerFirst, toPairs, toPascalCase, toSnakeCase, toUpperFirst, type, uniq, uniqBy, uniqWith, values, zip, zipObj, zipWith };