@naturalcycles/js-lib 14.191.0 → 14.192.0

package/dist/array/range.d.ts

@@ -1,3 +1,4 @@
+import { Iterable2 } from '../iter/iterable2';
 /**
  * Returns an array with ranges from `from` up to (but not including) `to`.
  *
@@ -10,3 +11,8 @@
  */
 export declare function _range(toExcl: number): number[];
 export declare function _range(fromIncl: number, toExcl: number, step?: number): number[];
+/**
+ * Like _range, but returns an Iterable2.
+ */
+export declare function _rangeIt(toExcl: number): Iterable2<number>;
+export declare function _rangeIt(fromIncl: number, toExcl: number, step?: number): Iterable2<number>;

package/dist/array/range.js

@@ -1,7 +1,7 @@
 "use strict";
-/* eslint-disable no-redeclare, unicorn/no-new-array */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._range = void 0;
+exports._rangeIt = exports._range = void 0;
+const iterable2_1 = require("../iter/iterable2");
 function _range(fromIncl, toExcl, step = 1) {
     if (toExcl === undefined) {
         return Array.from(new Array(fromIncl), (_, i) => i);
@@ -9,3 +9,17 @@ function _range(fromIncl, toExcl, step = 1) {
     return Array.from({ length: Math.ceil((toExcl - fromIncl) / step) }, (_, i) => i * step + fromIncl);
 }
 exports._range = _range;
+function _rangeIt(fromIncl, toExcl, step = 1) {
+    if (toExcl === undefined) {
+        toExcl = fromIncl;
+        fromIncl = 0;
+    }
+    return iterable2_1.Iterable2.of({
+        *[Symbol.iterator]() {
+            for (let i = fromIncl; i < toExcl; i += step) {
+                yield i;
+            }
+        },
+    });
+}
+exports._rangeIt = _rangeIt;

package/dist/datetime/localDate.d.ts

@@ -1,3 +1,4 @@
+import { Iterable2 } from '../iter/iterable2';
 import type { IsoDateString, IsoDateTimeString, MonthId, SortDirection, UnixTimestampMillisNumber, UnixTimestampNumber } from '../types';
 import { LocalTime } from './localTime';
 export type LocalDateUnit = LocalDateUnitStrict | 'week';
@@ -35,6 +36,10 @@ export declare class LocalDate {
     static latestOrUndefined(items: LocalDateInput[]): LocalDate | undefined;
     static latest(items: LocalDateInput[]): LocalDate;
     static range(min: LocalDateInput, max: LocalDateInput, incl?: Inclusiveness, step?: number, stepUnit?: LocalDateUnit): LocalDate[];
+    /**
+     * Experimental, returns the range as Iterable2.
+     */
+    static rangeIt(min: LocalDateInput, max: LocalDateInput, incl?: Inclusiveness, step?: number, stepUnit?: LocalDateUnit): Iterable2<LocalDate>;
     get(unit: LocalDateUnitStrict): number;
     set(unit: LocalDateUnitStrict, v: number, mutate?: boolean): LocalDate;
     year(): number;

package/dist/datetime/localDate.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.localDateOrToday = exports.localDateOrUndefined = exports.localDateToday = exports.localDate = exports.LocalDate = void 0;
 const assert_1 = require("../error/assert");
+const iterable2_1 = require("../iter/iterable2");
 const localTime_1 = require("./localTime");
 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)$/;
@@ -104,27 +105,37 @@ class LocalDate {
             .reduce((max, item) => (max.isSameOrAfter(item) ? max : item));
     }
     static range(min, max, incl = '[)', step = 1, stepUnit = 'day') {
+        return this.rangeIt(min, max, incl, step, stepUnit).toArray();
+    }
+    /**
+     * Experimental, returns the range as Iterable2.
+     */
+    static rangeIt(min, max, incl = '[)', step = 1, stepUnit = 'day') {
         if (stepUnit === 'week') {
             step *= 7;
             stepUnit = 'day';
         }
-        const dates = [];
-        const $min = LocalDate.of(min);
+        const $min = LocalDate.of(min).startOf(stepUnit);
         const $max = LocalDate.of(max).startOf(stepUnit);
-        let current = $min.startOf(stepUnit);
+        let value = $min;
         // eslint-disable-next-line @typescript-eslint/prefer-string-starts-ends-with
-        if (current.isAfter($min, incl[0] === '[')) {
+        if (value.isAfter($min, incl[0] === '[')) {
             // ok
         }
         else {
-            current.plus(1, stepUnit, true);
+            value.plus(1, stepUnit, true);
         }
-        const incl2 = incl[1] === ']';
-        while (current.isBefore($max, incl2)) {
-            dates.push(current);
-            current = current.plus(step, stepUnit);
-        }
-        return dates;
+        const rightInclusive = incl[1] === ']';
+        return iterable2_1.Iterable2.of({
+            *[Symbol.iterator]() {
+                while (value.isBefore($max, rightInclusive)) {
+                    yield value;
+                    // We don't mutate, because we already returned `current`
+                    // in the previous iteration
+                    value = value.plus(step, stepUnit);
+                }
+            },
+        });
     }
     get(unit) {
         return unit === 'year' ? this.$year : unit === 'month' ? this.$month : this.$day;

package/dist/index.d.ts

@@ -60,7 +60,7 @@ export * from './log/commonLogger';
 export * from './string/safeJsonStringify';
 export * from './promise/pQueue';
 export * from './promise/abortable';
-export * from './seq/seq';
+export * from './iter/iterable2';
 export * from './math/stack.util';
 export * from './string/leven';
 export * from './datetime/localDate';

package/dist/index.js

@@ -64,7 +64,7 @@ tslib_1.__exportStar(require("./log/commonLogger"), exports);
 tslib_1.__exportStar(require("./string/safeJsonStringify"), exports);
 tslib_1.__exportStar(require("./promise/pQueue"), exports);
 tslib_1.__exportStar(require("./promise/abortable"), exports);
-tslib_1.__exportStar(require("./seq/seq"), exports);
+tslib_1.__exportStar(require("./iter/iterable2"), exports);
 tslib_1.__exportStar(require("./math/stack.util"), exports);
 tslib_1.__exportStar(require("./string/leven"), exports);
 tslib_1.__exportStar(require("./datetime/localDate"), exports);

package/dist/iter/iterable2.d.ts

@@ -0,0 +1,21 @@
+import { AbortableMapper, AbortablePredicate, END, Predicate } from '../types';
+/**
+ * Iterable2 is a wrapper around Iterable that implements "Iterator Helpers proposal":
+ * https://github.com/tc39/proposal-iterator-helpers
+ *
+ * Iterable2 can be removed after the proposal is widely implemented in Node & browsers.
+ *
+ * @experimental
+ */
+export declare class Iterable2<T> implements Iterable<T> {
+    private it;
+    private constructor();
+    static of<T>(it: Iterable<T>): Iterable2<T>;
+    static empty<T>(): Iterable2<T>;
+    [Symbol.iterator](): Iterator<T>;
+    toArray(): T[];
+    forEach(cb: (v: T, i: number) => any | typeof END): void;
+    find(cb: Predicate<T>): T | undefined;
+    filter(cb: AbortablePredicate<T>): Iterable2<T>;
+    map<OUT>(mapper: AbortableMapper<T, OUT>): Iterable2<OUT>;
+}

package/dist/iter/iterable2.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Iterable2 = void 0;
+const types_1 = require("../types");
+/**
+ * Iterable2 is a wrapper around Iterable that implements "Iterator Helpers proposal":
+ * https://github.com/tc39/proposal-iterator-helpers
+ *
+ * Iterable2 can be removed after the proposal is widely implemented in Node & browsers.
+ *
+ * @experimental
+ */
+class Iterable2 {
+    constructor(it) {
+        this.it = it;
+    }
+    static of(it) {
+        return new Iterable2(it);
+    }
+    static empty() {
+        return new Iterable2([]);
+    }
+    [Symbol.iterator]() {
+        return this.it[Symbol.iterator]();
+    }
+    toArray() {
+        return [...this.it];
+    }
+    forEach(cb) {
+        let i = 0;
+        for (const v of this.it) {
+            if (cb(v, i++) === types_1.END)
+                return;
+        }
+    }
+    find(cb) {
+        let i = 0;
+        for (const v of this.it) {
+            if (cb(v, i++))
+                return v;
+        }
+    }
+    filter(cb) {
+        const { it } = this;
+        return new Iterable2({
+            *[Symbol.iterator]() {
+                let i = 0;
+                for (const v of it) {
+                    const r = cb(v, i++);
+                    if (r === types_1.END)
+                        return;
+                    if (r)
+                        yield v;
+                }
+            },
+        });
+    }
+    map(mapper) {
+        const { it } = this;
+        return new Iterable2({
+            *[Symbol.iterator]() {
+                let i = 0;
+                for (const v of it) {
+                    const r = mapper(v, i++);
+                    if (r === types_1.END)
+                        return;
+                    if (r === types_1.SKIP)
+                        continue;
+                    yield r;
+                }
+            },
+        });
+    }
+}
+exports.Iterable2 = Iterable2;

package/dist/string/stringify.d.ts

@@ -7,7 +7,7 @@ import type { Reviver } from '../types';
  *
  * Defaults to _safeJsonStringify.
  *
- * Node.js project can set it to _inspectAny, which allows to use `util.inspect`
+ * Node.js project can set it to _inspect, which allows to use `util.inspect`
  * as pretty-printing function.
  *
  * It's recommended that this function is circular-reference-safe.

package/dist/string/stringify.js

@@ -14,7 +14,7 @@ let globalStringifyFunction = safeJsonStringify_1._safeJsonStringify;
  *
  * Defaults to _safeJsonStringify.
  *
- * Node.js project can set it to _inspectAny, which allows to use `util.inspect`
+ * Node.js project can set it to _inspect, which allows to use `util.inspect`
  * as pretty-printing function.
  *
  * It's recommended that this function is circular-reference-safe.

package/dist-esm/array/range.js

@@ -1,7 +1,20 @@
-/* eslint-disable no-redeclare, unicorn/no-new-array */
+import { Iterable2 } from '../iter/iterable2';
 export function _range(fromIncl, toExcl, step = 1) {
     if (toExcl === undefined) {
         return Array.from(new Array(fromIncl), (_, i) => i);
     }
     return Array.from({ length: Math.ceil((toExcl - fromIncl) / step) }, (_, i) => i * step + fromIncl);
 }
+export function _rangeIt(fromIncl, toExcl, step = 1) {
+    if (toExcl === undefined) {
+        toExcl = fromIncl;
+        fromIncl = 0;
+    }
+    return Iterable2.of({
+        *[Symbol.iterator]() {
+            for (let i = fromIncl; i < toExcl; i += step) {
+                yield i;
+            }
+        },
+    });
+}

package/dist-esm/datetime/localDate.js

@@ -1,4 +1,5 @@
 import { _assert } from '../error/assert';
+import { Iterable2 } from '../iter/iterable2';
 import { LocalTime } from './localTime';
 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)$/;
@@ -101,27 +102,37 @@ export class LocalDate {
             .reduce((max, item) => (max.isSameOrAfter(item) ? max : item));
     }
     static range(min, max, incl = '[)', step = 1, stepUnit = 'day') {
+        return this.rangeIt(min, max, incl, step, stepUnit).toArray();
+    }
+    /**
+     * Experimental, returns the range as Iterable2.
+     */
+    static rangeIt(min, max, incl = '[)', step = 1, stepUnit = 'day') {
         if (stepUnit === 'week') {
             step *= 7;
             stepUnit = 'day';
         }
-        const dates = [];
-        const $min = LocalDate.of(min);
+        const $min = LocalDate.of(min).startOf(stepUnit);
         const $max = LocalDate.of(max).startOf(stepUnit);
-        let current = $min.startOf(stepUnit);
+        let value = $min;
         // eslint-disable-next-line @typescript-eslint/prefer-string-starts-ends-with
-        if (current.isAfter($min, incl[0] === '[')) {
+        if (value.isAfter($min, incl[0] === '[')) {
             // ok
         }
         else {
-            current.plus(1, stepUnit, true);
+            value.plus(1, stepUnit, true);
         }
-        const incl2 = incl[1] === ']';
-        while (current.isBefore($max, incl2)) {
-            dates.push(current);
-            current = current.plus(step, stepUnit);
-        }
-        return dates;
+        const rightInclusive = incl[1] === ']';
+        return Iterable2.of({
+            *[Symbol.iterator]() {
+                while (value.isBefore($max, rightInclusive)) {
+                    yield value;
+                    // We don't mutate, because we already returned `current`
+                    // in the previous iteration
+                    value = value.plus(step, stepUnit);
+                }
+            },
+        });
     }
     get(unit) {
         return unit === 'year' ? this.$year : unit === 'month' ? this.$month : this.$day;

package/dist-esm/index.js

@@ -60,7 +60,7 @@ export * from './log/commonLogger';
 export * from './string/safeJsonStringify';
 export * from './promise/pQueue';
 export * from './promise/abortable';
-export * from './seq/seq';
+export * from './iter/iterable2';
 export * from './math/stack.util';
 export * from './string/leven';
 export * from './datetime/localDate';

package/dist-esm/iter/iterable2.js

@@ -0,0 +1,71 @@
+import { END, SKIP } from '../types';
+/**
+ * Iterable2 is a wrapper around Iterable that implements "Iterator Helpers proposal":
+ * https://github.com/tc39/proposal-iterator-helpers
+ *
+ * Iterable2 can be removed after the proposal is widely implemented in Node & browsers.
+ *
+ * @experimental
+ */
+export class Iterable2 {
+    constructor(it) {
+        this.it = it;
+    }
+    static of(it) {
+        return new Iterable2(it);
+    }
+    static empty() {
+        return new Iterable2([]);
+    }
+    [Symbol.iterator]() {
+        return this.it[Symbol.iterator]();
+    }
+    toArray() {
+        return [...this.it];
+    }
+    forEach(cb) {
+        let i = 0;
+        for (const v of this.it) {
+            if (cb(v, i++) === END)
+                return;
+        }
+    }
+    find(cb) {
+        let i = 0;
+        for (const v of this.it) {
+            if (cb(v, i++))
+                return v;
+        }
+    }
+    filter(cb) {
+        const { it } = this;
+        return new Iterable2({
+            *[Symbol.iterator]() {
+                let i = 0;
+                for (const v of it) {
+                    const r = cb(v, i++);
+                    if (r === END)
+                        return;
+                    if (r)
+                        yield v;
+                }
+            },
+        });
+    }
+    map(mapper) {
+        const { it } = this;
+        return new Iterable2({
+            *[Symbol.iterator]() {
+                let i = 0;
+                for (const v of it) {
+                    const r = mapper(v, i++);
+                    if (r === END)
+                        return;
+                    if (r === SKIP)
+                        continue;
+                    yield r;
+                }
+            },
+        });
+    }
+}

package/dist-esm/string/stringify.js

@@ -11,7 +11,7 @@ let globalStringifyFunction = _safeJsonStringify;
  *
  * Defaults to _safeJsonStringify.
  *
- * Node.js project can set it to _inspectAny, which allows to use `util.inspect`
+ * Node.js project can set it to _inspect, which allows to use `util.inspect`
  * as pretty-printing function.
  *
  * It's recommended that this function is circular-reference-safe.

package/package.json

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

package/src/array/range.ts

@@ -1,3 +1,5 @@
+import { Iterable2 } from '../iter/iterable2'
+
 /* eslint-disable no-redeclare, unicorn/no-new-array */
 
 /**
@@ -22,3 +24,23 @@ export function _range(fromIncl: number, toExcl?: number, step = 1): number[] {
     (_, i) => i * step + fromIncl,
   )
 }
+
+/**
+ * Like _range, but returns an Iterable2.
+ */
+export function _rangeIt(toExcl: number): Iterable2<number>
+export function _rangeIt(fromIncl: number, toExcl: number, step?: number): Iterable2<number>
+export function _rangeIt(fromIncl: number, toExcl?: number, step = 1): Iterable2<number> {
+  if (toExcl === undefined) {
+    toExcl = fromIncl
+    fromIncl = 0
+  }
+
+  return Iterable2.of({
+    *[Symbol.iterator]() {
+      for (let i = fromIncl; i < toExcl!; i += step) {
+        yield i
+      }
+    },
+  })
+}

package/src/datetime/localDate.ts

@@ -1,4 +1,5 @@
 import { _assert } from '../error/assert'
+import { Iterable2 } from '../iter/iterable2'
 import type {
   IsoDateString,
   IsoDateTimeString,
@@ -149,30 +150,48 @@ export class LocalDate {
     step = 1,
     stepUnit: LocalDateUnit = 'day',
   ): LocalDate[] {
+    return this.rangeIt(min, max, incl, step, stepUnit).toArray()
+  }
+
+  /**
+   * Experimental, returns the range as Iterable2.
+   */
+  static rangeIt(
+    min: LocalDateInput,
+    max: LocalDateInput,
+    incl: Inclusiveness = '[)',
+    step = 1,
+    stepUnit: LocalDateUnit = 'day',
+  ): Iterable2<LocalDate> {
     if (stepUnit === 'week') {
       step *= 7
       stepUnit = 'day'
     }
 
-    const dates: LocalDate[] = []
-    const $min = LocalDate.of(min)
+    const $min = LocalDate.of(min).startOf(stepUnit)
     const $max = LocalDate.of(max).startOf(stepUnit)
 
-    let current = $min.startOf(stepUnit)
+    let value = $min
     // eslint-disable-next-line @typescript-eslint/prefer-string-starts-ends-with
-    if (current.isAfter($min, incl[0] === '[')) {
+    if (value.isAfter($min, incl[0] === '[')) {
       // ok
     } else {
-      current.plus(1, stepUnit, true)
+      value.plus(1, stepUnit, true)
     }
 
-    const incl2 = incl[1] === ']'
-    while (current.isBefore($max, incl2)) {
-      dates.push(current)
-      current = current.plus(step, stepUnit)
-    }
+    const rightInclusive = incl[1] === ']'
 
-    return dates
+    return Iterable2.of({
+      *[Symbol.iterator]() {
+        while (value.isBefore($max, rightInclusive)) {
+          yield value
+
+          // We don't mutate, because we already returned `current`
+          // in the previous iteration
+          value = value.plus(step, stepUnit)
+        }
+      },
+    })
   }
 
   get(unit: LocalDateUnitStrict): number {

package/src/index.ts

@@ -60,7 +60,7 @@ export * from './log/commonLogger'
 export * from './string/safeJsonStringify'
 export * from './promise/pQueue'
 export * from './promise/abortable'
-export * from './seq/seq'
+export * from './iter/iterable2'
 export * from './math/stack.util'
 export * from './string/leven'
 export * from './datetime/localDate'

package/src/iter/iterable2.ts

@@ -0,0 +1,74 @@
+import { AbortableMapper, AbortablePredicate, END, Predicate, SKIP } from '../types'
+
+/**
+ * Iterable2 is a wrapper around Iterable that implements "Iterator Helpers proposal":
+ * https://github.com/tc39/proposal-iterator-helpers
+ *
+ * Iterable2 can be removed after the proposal is widely implemented in Node & browsers.
+ *
+ * @experimental
+ */
+export class Iterable2<T> implements Iterable<T> {
+  private constructor(private it: Iterable<T>) {}
+
+  static of<T>(it: Iterable<T>): Iterable2<T> {
+    return new Iterable2(it)
+  }
+
+  static empty<T>(): Iterable2<T> {
+    return new Iterable2([])
+  }
+
+  [Symbol.iterator](): Iterator<T> {
+    return this.it[Symbol.iterator]()
+  }
+
+  toArray(): T[] {
+    return [...this.it]
+  }
+
+  forEach(cb: (v: T, i: number) => any | typeof END): void {
+    let i = 0
+    for (const v of this.it) {
+      if (cb(v, i++) === END) return
+    }
+  }
+
+  find(cb: Predicate<T>): T | undefined {
+    let i = 0
+    for (const v of this.it) {
+      if (cb(v, i++)) return v
+    }
+  }
+
+  filter(cb: AbortablePredicate<T>): Iterable2<T> {
+    const { it } = this
+
+    return new Iterable2<T>({
+      *[Symbol.iterator]() {
+        let i = 0
+        for (const v of it) {
+          const r = cb(v, i++)
+          if (r === END) return
+          if (r) yield v
+        }
+      },
+    })
+  }
+
+  map<OUT>(mapper: AbortableMapper<T, OUT>): Iterable2<OUT> {
+    const { it } = this
+
+    return new Iterable2<OUT>({
+      *[Symbol.iterator]() {
+        let i = 0
+        for (const v of it) {
+          const r = mapper(v, i++)
+          if (r === END) return
+          if (r === SKIP) continue
+          yield r
+        }
+      },
+    })
+  }
+}

package/src/string/stringify.ts

@@ -15,7 +15,7 @@ let globalStringifyFunction: JsonStringifyFunction = _safeJsonStringify
  *
  * Defaults to _safeJsonStringify.
  *
- * Node.js project can set it to _inspectAny, which allows to use `util.inspect`
+ * Node.js project can set it to _inspect, which allows to use `util.inspect`
  * as pretty-printing function.
  *
  * It's recommended that this function is circular-reference-safe.