@naturalcycles/js-lib 15.8.1 → 15.9.1

package/src/number/number.util.ts

@@ -1,4 +1,5 @@
-import type { Inclusiveness, SortDirection } from '../types.js'
+import type { SortOptions } from '../array/array.util.js'
+import type { Inclusiveness } from '../types.js'
 
 export function _randomInt(minIncl: number, maxIncl: number): number {
   return Math.floor(Math.random() * (maxIncl - minIncl + 1) + minIncl)
@@ -42,18 +43,11 @@ export function _isBetween<T extends number | string>(
   x: T,
   min: T,
   max: T,
-  incl: Inclusiveness = '[)',
+  incl: Inclusiveness,
 ): boolean {
-  if (incl === '[)') {
-    return x >= min && x < max
-  }
-  if (incl === '[]') {
-    return x >= min && x <= max
-  }
-  if (incl === '(]') {
-    return x > min && x <= max
-  }
-  return x > min && x < max
+  if (x < min || x > max) return false
+  if (x === max && incl === '[)') return false
+  return true
 }
 
 export function _clamp(x: number, minIncl: number, maxIncl: number): number {
@@ -70,13 +64,9 @@ export function _clamp(x: number, minIncl: number, maxIncl: number): number {
  * _sortNumbers([1, 3, 2])
  * // [1, 2, 3]
  */
-export function _sortNumbers(
-  numbers: number[],
-  mutate = false,
-  dir: SortDirection = 'asc',
-): number[] {
-  const mod = dir === 'desc' ? -1 : 1
-  return (mutate ? numbers : [...numbers]).sort((a, b) => (a - b) * mod)
+export function _sortNumbers(numbers: number[], opt: SortOptions = {}): number[] {
+  const mod = opt.dir === 'desc' ? -1 : 1
+  return (opt.mutate ? numbers : [...numbers]).sort((a, b) => (a - b) * mod)
 }
 
 /**

package/src/object/object.util.ts

@@ -1,3 +1,4 @@
+import type { MutateOptions } from '../array/array.util.js'
 import { _isEmpty, _isObject } from '../is.util.js'
 import type {
   AnyObject,
@@ -16,9 +17,9 @@ import { _objectEntries, SKIP } from '../types.js'
 export function _pick<T extends AnyObject, K extends keyof T>(
   obj: T,
   props: readonly K[],
-  mutate = false,
+  opt: MutateOptions = {},
 ): T {
-  if (mutate) {
+  if (opt.mutate) {
     // Start as original object (mutable), DELETE properties that are not whitelisted
     for (const k of Object.keys(obj)) {
       if (!props.includes(k as K)) delete obj[k]
@@ -40,9 +41,9 @@ export function _pick<T extends AnyObject, K extends keyof T>(
 export function _pickWithUndefined<T extends AnyObject, K extends keyof T>(
   obj: T,
   props: readonly K[],
-  mutate = false,
+  opt: MutateOptions = {},
 ): T {
-  const r: T = mutate ? obj : { ...obj }
+  const r: T = opt.mutate ? obj : { ...obj }
   for (const k of Object.keys(r)) {
     if (!props.includes(k as K)) {
       r[k as K] = undefined as any
@@ -58,9 +59,9 @@ export function _pickWithUndefined<T extends AnyObject, K extends keyof T>(
 export function _omit<T extends AnyObject, K extends keyof T>(
   obj: T,
   props: readonly K[],
-  mutate = false,
+  opt: MutateOptions = {},
 ): T {
-  if (mutate) {
+  if (opt.mutate) {
     for (const k of props) {
       delete obj[k]
     }
@@ -81,9 +82,9 @@ export function _omit<T extends AnyObject, K extends keyof T>(
 export function _omitWithUndefined<T extends AnyObject, K extends keyof T>(
   obj: T,
   props: readonly K[],
-  mutate = false,
+  opt: MutateOptions = {},
 ): T {
-  const r: T = mutate ? obj : { ...obj }
+  const r: T = opt.mutate ? obj : { ...obj }
   for (const k of props) {
     r[k] = undefined as any
   }
@@ -98,8 +99,8 @@ export function _omitWithUndefined<T extends AnyObject, K extends keyof T>(
  *  'account.updated',
  * ])
  */
-export function _mask<T extends AnyObject>(obj: T, props: string[], mutate = false): T {
-  const r = mutate ? obj : _deepCopy(obj)
+export function _mask<T extends AnyObject>(obj: T, props: string[], opt: MutateOptions = {}): T {
+  const r = opt.mutate ? obj : _deepCopy(obj)
   for (const k of props) {
     _unset(r, k)
   }
@@ -109,27 +110,27 @@ export function _mask<T extends AnyObject>(obj: T, props: string[], mutate = fal
 /**
  * Removes "falsy" values from the object.
  */
-export function _filterFalsyValues<T extends AnyObject>(obj: T, mutate = false): T {
-  return _filterObject(obj, (_k, v) => !!v, mutate)
+export function _filterFalsyValues<T extends AnyObject>(obj: T, opt: MutateOptions = {}): T {
+  return _filterObject(obj, (_k, v) => !!v, opt)
 }
 
 /**
  * Removes values from the object that are `null` or `undefined`.
  */
-export function _filterNullishValues<T extends AnyObject>(obj: T, mutate = false): T {
-  return _filterObject(obj, (_k, v) => v !== undefined && v !== null, mutate)
+export function _filterNullishValues<T extends AnyObject>(obj: T, opt: MutateOptions = {}): T {
+  return _filterObject(obj, (_k, v) => v !== undefined && v !== null, opt)
 }
 
 /**
  * Removes values from the object that are `undefined`.
  * Only `undefined` values are removed. `null` values are kept!
  */
-export function _filterUndefinedValues<T extends AnyObject>(obj: T, mutate = false): T {
-  return _filterObject(obj, (_k, v) => v !== undefined, mutate)
+export function _filterUndefinedValues<T extends AnyObject>(obj: T, opt: MutateOptions = {}): T {
+  return _filterObject(obj, (_k, v) => v !== undefined, opt)
 }
 
-export function _filterEmptyArrays<T extends AnyObject>(obj: T, mutate = false): T {
-  return _filterObject(obj, (_k, v) => !Array.isArray(v) || v.length > 0, mutate)
+export function _filterEmptyArrays<T extends AnyObject>(obj: T, opt: MutateOptions = {}): T {
+  return _filterObject(obj, (_k, v) => !Array.isArray(v) || v.length > 0, opt)
 }
 
 /**
@@ -139,9 +140,9 @@ export function _filterEmptyArrays<T extends AnyObject>(obj: T, mutate = false):
 export function _filterObject<T extends AnyObject>(
   obj: T,
   predicate: ObjectPredicate<T>,
-  mutate = false,
+  opt: MutateOptions = {},
 ): T {
-  if (mutate) {
+  if (opt.mutate) {
     for (const [k, v] of _objectEntries(obj)) {
       if (!predicate(k, v, obj)) {
         delete obj[k]
@@ -173,9 +174,9 @@ export function _filterObject<T extends AnyObject>(
 export function _mapValues<OUT = unknown, IN extends AnyObject = AnyObject>(
   obj: IN,
   mapper: ObjectMapper<IN, any>,
-  mutate = false,
+  opt: MutateOptions = {},
 ): OUT {
-  const map: any = mutate ? obj : {}
+  const map: any = opt.mutate ? obj : {}
   for (const [k, v] of Object.entries(obj)) {
     map[k] = mapper(k, v, obj)
   }
@@ -231,8 +232,11 @@ export function _findKeyByValue<T extends AnyObject>(obj: T, v: ValueOf<T>): key
   return Object.entries(obj).find(([_, value]) => value === v)?.[0] as keyof T
 }
 
-export function _objectNullValuesToUndefined<T extends AnyObject>(obj: T, mutate = false): T {
-  return _mapValues(obj, (_k, v) => (v === null ? undefined : v), mutate)
+export function _objectNullValuesToUndefined<T extends AnyObject>(
+  obj: T,
+  opt: MutateOptions = {},
+): T {
+  return _mapValues(obj, (_k, v) => (v === null ? undefined : v), opt)
 }
 
 /**
@@ -253,8 +257,8 @@ export function _undefinedIfEmpty<T>(obj: T | undefined): T | undefined {
 /**
  * Filters the object by removing all key-value pairs where Value is Empty (according to _isEmpty() specification).
  */
-export function _filterEmptyValues<T extends AnyObject>(obj: T, mutate = false): T {
-  return _filterObject(obj, (_k, v) => !_isEmpty(v), mutate)
+export function _filterEmptyValues<T extends AnyObject>(obj: T, opt: MutateOptions = {}): T {
+  return _filterObject(obj, (_k, v) => !_isEmpty(v), opt)
 }
 
 /**

package/src/semver.ts

@@ -1,6 +1,6 @@
+import type { SortOptions } from './array/array.util.js'
 import { _range } from './array/range.js'
 import { _assert } from './error/assert.js'
-import type { SortDirection } from './types.js'
 
 export type SemverInput = string | Semver
 export type SemverInputNullable = SemverInput | null | undefined
@@ -134,9 +134,9 @@ class SemverFactory {
   /**
    * Sorts an array of Semvers in `dir` order (ascending by default).
    */
-  sort(items: Semver[], dir: SortDirection = 'asc', mutate = false): Semver[] {
-    const mod = dir === 'desc' ? -1 : 1
-    return (mutate ? items : [...items]).sort((a, b) => a.compare(b) * mod)
+  sort(items: Semver[], opt: SortOptions = {}): Semver[] {
+    const mod = opt.dir === 'desc' ? -1 : 1
+    return (opt.mutate ? items : [...items]).sort((a, b) => a.compare(b) * mod)
   }
 }
 

package/src/types.ts

@@ -144,11 +144,16 @@ export const MISS = Symbol('MISS')
 /**
  * Function which is called for every item in `input`. Expected to return a `Promise` or value.
  */
-export type AsyncMapper<IN = any, OUT = any> = (input: IN, index: number) => OUT | PromiseLike<OUT>
-export type Mapper<IN = any, OUT = any> = (input: IN, index: number) => OUT
+export type AsyncMapper<IN = any, OUT = any> = (input: IN) => OUT | PromiseLike<OUT>
+export type AsyncIndexedMapper<IN = any, OUT = any> = (
+  input: IN,
+  index: number,
+) => OUT | PromiseLike<OUT>
+export type Mapper<IN = any, OUT = any> = (input: IN) => OUT
+export type IndexedMapper<IN = any, OUT = any> = (input: IN, index: number) => OUT
 
-export const _passthroughMapper: Mapper = item => item
-export const _passUndefinedMapper: Mapper<any, void> = () => undefined
+export const _passthroughMapper: IndexedMapper = item => item
+export const _passUndefinedMapper: IndexedMapper<any, void> = () => undefined
 
 /**
  * Function that does nothings and returns `undefined`.
@@ -350,7 +355,7 @@ export function _stringMapValuesSorted<T>(
   mapper: Mapper<T, any>,
   dir: SortDirection = 'asc',
 ): T[] {
-  return _sortBy(_stringMapValues(map), mapper, false, dir)
+  return _sortBy(_stringMapValues(map), mapper, { dir })
 }
 
 /**
@@ -419,7 +424,7 @@ export type ErrorDataTuple<T = unknown, ERR = Error> = [err: null, data: T] | [e
 
 export type SortDirection = 'asc' | 'desc'
 
-export type Inclusiveness = '()' | '[]' | '[)' | '(]'
+export type Inclusiveness = '[]' | '[)'
 
 /**
  * @experimental