shelving 1.36.0 → 1.37.0

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.36.0",
+	"version": "1.37.0",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",

package/stream/ArrayState.d.ts

@@ -3,8 +3,8 @@ import { State } from "./State.js";
 /** State that stores an array and has additional methods to help with that. */
 export declare class ArrayState<T> extends State<ImmutableArray<T>> implements Iterable<T> {
     _value: never[];
-    /** Count the number of entries in this map-like object. */
-    get count(): number;
+    /** Get the length of the current value of this state. */
+    get length(): number;
     /** Add an item to this array. */
     add(item: T): void;
     /** Remove an item from this array. */

package/stream/ArrayState.js

@@ -1,4 +1,4 @@
-import { swapItem, toggleItem, withItem, withoutItem, countItems } from "../util/index.js";
+import { swapItem, toggleItem, withItem, withoutItem } from "../util/index.js";
 import { State } from "./State.js";
 /** State that stores an array and has additional methods to help with that. */
 export class ArrayState extends State {
@@ -7,9 +7,9 @@ export class ArrayState extends State {
         // Set default value to be empty array.
         this._value = [];
     }
-    /** Count the number of entries in this map-like object. */
-    get count() {
-        return countItems(this.value);
+    /** Get the length of the current value of this state. */
+    get length() {
+        return this.value.length;
     }
     /** Add an item to this array. */
     add(item) {

package/util/iterate.d.ts

@@ -1,4 +1,3 @@
-import type { ImmutableMap } from "./map.js";
 import type { ImmutableArray } from "./array.js";
 import type { Entry } from "./entry.js";
 import { DONE } from "./constants.js";
@@ -23,8 +22,6 @@ export declare const isIterable: <T extends Iterable<unknown>>(value: unknown) =
  * - Note: Array and Map instances etc will return true because they implement `Symbol.iterator`
  */
 export declare const isAsyncIterable: <T extends AsyncIterable<unknown>>(value: unknown) => value is T;
-/** Get the known size or length of an object (e.g. `Array`, `Map`, and `Set` have known size), or return `undefined` if the size cannot be established. */
-export declare const getSize: (obj: Iterable<unknown> | ImmutableMap | ImmutableArray) => number | undefined;
 /**
  * Count the number items of an iterable.
  * - Checks `items.size` or `items.length` first, or consumes the iterable and counts its iterations.
@@ -35,8 +32,6 @@ export declare function countItems(items: Iterable<unknown>): number;
  * - Note: this consumes the iterable so you won't be able to use it again.
  */
 export declare function countIterations(items: Iterable<unknown>): number;
-/** Sum an iterable set of numbers and return the total. */
-export declare function sumItems(input: Iterable<number>): number;
 /**
  * Yield a range of numbers from `start` to `end`
  * - Yields in descending order if `end` is lower than `start`

package/util/iterate.js

@@ -13,14 +13,14 @@ export const isIterable = (value) => typeof value === "object" && !!value && Sym
  */
 export const isAsyncIterable = (value) => typeof value === "object" && !!value && Symbol.asyncIterator in value;
 /** Get the known size or length of an object (e.g. `Array`, `Map`, and `Set` have known size), or return `undefined` if the size cannot be established. */
-export const getSize = (obj) => ("size" in obj && typeof obj.size === "number" ? obj.size : "length" in obj && typeof obj.length === "number" ? obj.length : undefined);
+const getKnownSize = (obj) => ("size" in obj && typeof obj.size === "number" ? obj.size : "length" in obj && typeof obj.length === "number" ? obj.length : undefined);
 /**
  * Count the number items of an iterable.
  * - Checks `items.size` or `items.length` first, or consumes the iterable and counts its iterations.
  */
 export function countItems(items) {
     var _a;
-    return (_a = getSize(items)) !== null && _a !== void 0 ? _a : countIterations(items);
+    return (_a = getKnownSize(items)) !== null && _a !== void 0 ? _a : countIterations(items);
 }
 /**
  * Count the number of iterations an iterable does.
@@ -32,13 +32,6 @@ export function countIterations(items) {
         count++; // eslint-disable-line @typescript-eslint/no-unused-vars
     return count;
 }
-/** Sum an iterable set of numbers and return the total. */
-export function sumItems(input) {
-    let sum = 0;
-    for (const num of input)
-        sum += num;
-    return sum;
-}
 /**
  * Yield a range of numbers from `start` to `end`
  * - Yields in descending order if `end` is lower than `start`
@@ -57,7 +50,7 @@ export function* yieldRange(start, end) {
  */
 export function limitItems(items, limit) {
     var _a;
-    const size = (_a = getSize(items)) !== null && _a !== void 0 ? _a : Infinity;
+    const size = (_a = getKnownSize(items)) !== null && _a !== void 0 ? _a : Infinity;
     return size <= limit ? items : yieldUntilLimit(items, limit);
 }
 /** Yield items from a source iterable until we hit a maximum iteration count. */

package/util/number.d.ts

@@ -49,10 +49,14 @@ export declare const formatNumber: (num: number, precision?: number) => string;
  */
 export declare const isBetween: (num: number, start: number, end: number) => boolean;
 /**
- *  Apply a min/max to a number to return a number that's definitely in the specified range.
+ * Apply a min/max to a number to return a number that's definitely in the specified range.
  *
  * @param num The number to apply the min/max to, e.g. `17`
  * @param start The start of the range, e.g. `10`
  * @param end The end of the range, e.g. `20`
  */
 export declare const getBetween: (num: number, start: number, end: number) => number;
+/** Sum an iterable set of numbers and return the total. */
+export declare function sumNumbers(nums: Iterable<number>): number;
+/** Find the number that's closest to a target in an iterable set of numbers. */
+export declare function getClosestNumber<T extends number>(nums: Iterable<T>, target: number): T | undefined;

package/util/number.js

@@ -68,10 +68,25 @@ export const formatNumber = (num, precision = 10) => new Intl.NumberFormat(undef
  */
 export const isBetween = (num, start, end) => num >= start && num <= end;
 /**
- *  Apply a min/max to a number to return a number that's definitely in the specified range.
+ * Apply a min/max to a number to return a number that's definitely in the specified range.
  *
  * @param num The number to apply the min/max to, e.g. `17`
  * @param start The start of the range, e.g. `10`
  * @param end The end of the range, e.g. `20`
  */
 export const getBetween = (num, start, end) => Math.max(start, Math.min(end, num));
+/** Sum an iterable set of numbers and return the total. */
+export function sumNumbers(nums) {
+    let sum = 0;
+    for (const num of nums)
+        sum += num;
+    return sum;
+}
+/** Find the number that's closest to a target in an iterable set of numbers. */
+export function getClosestNumber(nums, target) {
+    let closest = undefined;
+    for (const item of nums)
+        if (closest === undefined || Math.abs(item - target) < Math.abs(closest - target))
+            closest = item;
+    return closest;
+}