@naturalcycles/js-lib 14.192.1 → 14.194.0

package/dist/datetime/dateInterval.d.ts

@@ -1,4 +1,5 @@
-import type { Inclusiveness, LocalDateInput, LocalDateUnit } from './localDate';
+import { Inclusiveness } from '../types';
+import type { LocalDateInput, LocalDateUnit } from './localDate';
 import { LocalDate } from './localDate';
 export type DateIntervalConfig = DateInterval | DateIntervalString;
 export type DateIntervalString = string;

package/dist/datetime/localDate.d.ts

@@ -1,9 +1,8 @@
 import { Iterable2 } from '../iter/iterable2';
-import type { IsoDateString, IsoDateTimeString, MonthId, SortDirection, UnixTimestampMillisNumber, UnixTimestampNumber } from '../types';
+import type { Inclusiveness, IsoDateString, IsoDateTimeString, MonthId, SortDirection, UnixTimestampMillisNumber, UnixTimestampNumber } from '../types';
 import { LocalTime } from './localTime';
 export type LocalDateUnit = LocalDateUnitStrict | 'week';
 export type LocalDateUnitStrict = 'year' | 'month' | 'day';
-export type Inclusiveness = '()' | '[]' | '[)' | '(]';
 export type LocalDateInput = LocalDate | Date | IsoDateString;
 export type LocalDateFormatter = (ld: LocalDate) => string;
 /**

package/dist/datetime/localTime.d.ts

@@ -1,5 +1,4 @@
-import type { IsoDateString, IsoDateTimeString, MonthId, SortDirection, UnixTimestampMillisNumber, UnixTimestampNumber } from '../types';
-import type { Inclusiveness } from './localDate';
+import type { Inclusiveness, IsoDateString, IsoDateTimeString, MonthId, SortDirection, UnixTimestampMillisNumber, UnixTimestampNumber } from '../types';
 import { LocalDate } from './localDate';
 export type LocalTimeUnit = 'year' | 'month' | 'week' | 'day' | 'hour' | 'minute' | 'second';
 export declare enum ISODayOfWeek {

package/dist/datetime/timeInterval.d.ts

@@ -1,5 +1,4 @@
-import type { UnixTimestampNumber } from '../types';
-import type { Inclusiveness } from './localDate';
+import type { UnixTimestampNumber, Inclusiveness } from '../types';
 import type { LocalTimeInput } from './localTime';
 import { LocalTime } from './localTime';
 export type TimeIntervalConfig = TimeInterval | TimeIntervalString;

package/dist/number/number.util.d.ts

@@ -1,4 +1,4 @@
-import { SortDirection } from '../types';
+import type { Inclusiveness, SortDirection } from '../types';
 export declare function _randomInt(minIncl: number, maxIncl: number): number;
 /**
  * Returns random item from an array.
@@ -7,13 +7,23 @@ export declare function _randomInt(minIncl: number, maxIncl: number): number;
  */
 export declare function _randomArrayItem<T>(array: T[]): T;
 /**
- *  _inRange(-10, 1, 5) // false
- * _inRange(1, 1, 5) // true
- * _inRange(3, 1, 5) // true
- * _inRange(5, 1, 5) // false
- * _inRange(7, 1, 5) // false
+ * Convenience function to "throttle" some code - run it less often.
+ *
+ * @example
+ *
+ * if (_runLessOften(10)) {
+ *   // this code will run only 10% of the time
+ * }
+ */
+export declare function _runLessOften(percent: number): boolean;
+/**
+ *  _isBetween(-10, 1, 5) // false
+ * _isBetween(1, 1, 5) // true
+ * _isBetween(3, 1, 5) // true
+ * _isBetween(5, 1, 5) // false
+ * _isBetween(7, 1, 5) // false
  */
-export declare function _inRange(x: number, minIncl: number, maxExcl: number): boolean;
+export declare function _isBetween(x: number, min: number, max: number, incl?: Inclusiveness): boolean;
 export declare function _clamp(x: number, minIncl: number, maxIncl: number): number;
 /**
  * This function exists, because in JS you cannot just .sort() numbers,

package/dist/number/number.util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._round = exports._toPrecision = exports._toFixed = exports._sortNumbers = exports._clamp = exports._inRange = exports._randomArrayItem = exports._randomInt = void 0;
+exports._round = exports._toPrecision = exports._toFixed = exports._sortNumbers = exports._clamp = exports._isBetween = exports._runLessOften = exports._randomArrayItem = exports._randomInt = void 0;
 function _randomInt(minIncl, maxIncl) {
     return Math.floor(Math.random() * (maxIncl - minIncl + 1) + minIncl);
 }
@@ -14,18 +14,41 @@ function _randomArrayItem(array) {
     return array[_randomInt(0, array.length - 1)];
 }
 exports._randomArrayItem = _randomArrayItem;
+/**
+ * Convenience function to "throttle" some code - run it less often.
+ *
+ * @example
+ *
+ * if (_runLessOften(10)) {
+ *   // this code will run only 10% of the time
+ * }
+ */
+function _runLessOften(percent) {
+    return Math.random() * 100 < percent;
+}
+exports._runLessOften = _runLessOften;
 // todo: _.random to support floats
 /**
- *  _inRange(-10, 1, 5) // false
- * _inRange(1, 1, 5) // true
- * _inRange(3, 1, 5) // true
- * _inRange(5, 1, 5) // false
- * _inRange(7, 1, 5) // false
+ *  _isBetween(-10, 1, 5) // false
+ * _isBetween(1, 1, 5) // true
+ * _isBetween(3, 1, 5) // true
+ * _isBetween(5, 1, 5) // false
+ * _isBetween(7, 1, 5) // false
  */
-function _inRange(x, minIncl, maxExcl) {
-    return x >= minIncl && x < maxExcl;
+function _isBetween(x, min, max, incl = '[)') {
+    if (incl === '[)') {
+        return x >= min && x < max;
+    }
+    else if (incl === '[]') {
+        return x >= min && x <= max;
+    }
+    else if (incl === '(]') {
+        return x > min && x <= max;
+    }
+    // ()
+    return x > min && x < max;
 }
-exports._inRange = _inRange;
+exports._isBetween = _isBetween;
 function _clamp(x, minIncl, maxIncl) {
     return x <= minIncl ? minIncl : x >= maxIncl ? maxIncl : x;
 }

package/dist/types.d.ts

@@ -243,3 +243,4 @@ export declare const _objectAssign: <T extends AnyObject>(target: T, part: Parti
  */
 export type ErrorDataTuple<T = unknown, ERR = Error> = [err: null, data: T] | [err: ERR, data: null];
 export type SortDirection = 'asc' | 'desc';
+export type Inclusiveness = '()' | '[]' | '[)' | '(]';

package/dist-esm/number/number.util.js

@@ -9,16 +9,38 @@ export function _randomInt(minIncl, maxIncl) {
 export function _randomArrayItem(array) {
     return array[_randomInt(0, array.length - 1)];
 }
+/**
+ * Convenience function to "throttle" some code - run it less often.
+ *
+ * @example
+ *
+ * if (_runLessOften(10)) {
+ *   // this code will run only 10% of the time
+ * }
+ */
+export function _runLessOften(percent) {
+    return Math.random() * 100 < percent;
+}
 // todo: _.random to support floats
 /**
- *  _inRange(-10, 1, 5) // false
- * _inRange(1, 1, 5) // true
- * _inRange(3, 1, 5) // true
- * _inRange(5, 1, 5) // false
- * _inRange(7, 1, 5) // false
+ *  _isBetween(-10, 1, 5) // false
+ * _isBetween(1, 1, 5) // true
+ * _isBetween(3, 1, 5) // true
+ * _isBetween(5, 1, 5) // false
+ * _isBetween(7, 1, 5) // false
  */
-export function _inRange(x, minIncl, maxExcl) {
-    return x >= minIncl && x < maxExcl;
+export function _isBetween(x, min, max, incl = '[)') {
+    if (incl === '[)') {
+        return x >= min && x < max;
+    }
+    else if (incl === '[]') {
+        return x >= min && x <= max;
+    }
+    else if (incl === '(]') {
+        return x > min && x <= max;
+    }
+    // ()
+    return x > min && x < max;
 }
 export function _clamp(x, minIncl, maxIncl) {
     return x <= minIncl ? minIncl : x >= maxIncl ? maxIncl : x;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/js-lib",
-  "version": "14.192.1",
+  "version": "14.194.0",
   "scripts": {
     "prepare": "husky install",
     "build-prod": "build-prod-esm-cjs",

package/src/datetime/dateInterval.ts

@@ -1,4 +1,5 @@
-import type { Inclusiveness, LocalDateInput, LocalDateUnit } from './localDate'
+import { Inclusiveness } from '../types'
+import type { LocalDateInput, LocalDateUnit } from './localDate'
 import { LocalDate, localDateRange } from './localDate'
 
 export type DateIntervalConfig = DateInterval | DateIntervalString

package/src/datetime/localDate.ts

@@ -1,6 +1,7 @@
 import { _assert } from '../error/assert'
 import { Iterable2 } from '../iter/iterable2'
 import type {
+  Inclusiveness,
   IsoDateString,
   IsoDateTimeString,
   MonthId,
@@ -12,7 +13,6 @@ import { LocalTime } from './localTime'
 
 export type LocalDateUnit = LocalDateUnitStrict | 'week'
 export type LocalDateUnitStrict = 'year' | 'month' | 'day'
-export type Inclusiveness = '()' | '[]' | '[)' | '(]'
 
 const MDAYS = [0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
 const DATE_REGEX = /^(\d\d\d\d)-(\d\d)-(\d\d)$/

package/src/datetime/localTime.ts

@@ -1,6 +1,7 @@
 import { _assert } from '../error/assert'
 import { _ms } from '../time/time.util'
 import type {
+  Inclusiveness,
   IsoDateString,
   IsoDateTimeString,
   MonthId,
@@ -8,7 +9,6 @@ import type {
   UnixTimestampMillisNumber,
   UnixTimestampNumber,
 } from '../types'
-import type { Inclusiveness } from './localDate'
 import { LocalDate } from './localDate'
 
 export type LocalTimeUnit = 'year' | 'month' | 'week' | 'day' | 'hour' | 'minute' | 'second'

package/src/datetime/timeInterval.ts

@@ -1,5 +1,4 @@
-import type { UnixTimestampNumber } from '../types'
-import type { Inclusiveness } from './localDate'
+import type { UnixTimestampNumber, Inclusiveness } from '../types'
 import type { LocalTimeInput } from './localTime'
 import { LocalTime } from './localTime'
 

package/src/number/number.util.ts

@@ -1,4 +1,4 @@
-import { SortDirection } from '../types'
+import type { Inclusiveness, SortDirection } from '../types'
 
 export function _randomInt(minIncl: number, maxIncl: number): number {
   return Math.floor(Math.random() * (maxIncl - minIncl + 1) + minIncl)
@@ -13,17 +13,43 @@ export function _randomArrayItem<T>(array: T[]): T {
   return array[_randomInt(0, array.length - 1)]!
 }
 
+/**
+ * Convenience function to "throttle" some code - run it less often.
+ *
+ * @example
+ *
+ * if (_runLessOften(10)) {
+ *   // this code will run only 10% of the time
+ * }
+ */
+export function _runLessOften(percent: number): boolean {
+  return Math.random() * 100 < percent
+}
+
 // todo: _.random to support floats
 
 /**
- *  _inRange(-10, 1, 5) // false
- * _inRange(1, 1, 5) // true
- * _inRange(3, 1, 5) // true
- * _inRange(5, 1, 5) // false
- * _inRange(7, 1, 5) // false
+ *  _isBetween(-10, 1, 5) // false
+ * _isBetween(1, 1, 5) // true
+ * _isBetween(3, 1, 5) // true
+ * _isBetween(5, 1, 5) // false
+ * _isBetween(7, 1, 5) // false
  */
-export function _inRange(x: number, minIncl: number, maxExcl: number): boolean {
-  return x >= minIncl && x < maxExcl
+export function _isBetween(
+  x: number,
+  min: number,
+  max: number,
+  incl: Inclusiveness = '[)',
+): boolean {
+  if (incl === '[)') {
+    return x >= min && x < max
+  } else if (incl === '[]') {
+    return x >= min && x <= max
+  } else if (incl === '(]') {
+    return x > min && x <= max
+  }
+  // ()
+  return x > min && x < max
 }
 
 export function _clamp(x: number, minIncl: number, maxIncl: number): number {

package/src/types.ts

@@ -326,3 +326,5 @@ export const _objectAssign = Object.assign as <T extends AnyObject>(
 export type ErrorDataTuple<T = unknown, ERR = Error> = [err: null, data: T] | [err: ERR, data: null]
 
 export type SortDirection = 'asc' | 'desc'
+
+export type Inclusiveness = '()' | '[]' | '[)' | '(]'