shelving 1.148.0 → 1.149.0

package/package.json

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

package/util/array.d.ts

@@ -95,6 +95,9 @@ export declare function getUniqueArray<T>(list: PossibleArray<T>): ImmutableArra
 export declare function limitArray<T>(list: PossibleArray<T>, limit: number): ImmutableArray<T>;
 /** Count the items in an array. */
 export declare function countArray<T>(arr: ImmutableArray<T>): number;
+/** Interleave array items with a separator */
+export declare function interleaveArray<T>(items: PossibleArray<T>, separator: T): ImmutableArray<T>;
+export declare function interleaveArray<A, B>(items: PossibleArray<A>, separator: B): ImmutableArray<A | B>;
 /** Get the first item from an array or iterable, or `undefined` if it didn't exist. */
 export declare function getFirst<T>(items: PossibleArray<T>): T | undefined;
 /** Get the first item from an array or iterable. */

package/util/array.js

@@ -1,5 +1,5 @@
 import { RequiredError } from "../error/RequiredError.js";
-import { omitItems, pickItems } from "./iterate.js";
+import { interleaveItems, omitItems, pickItems } from "./iterate.js";
 export function isArray(value, min = 0, max = Number.POSITIVE_INFINITY) {
     return Array.isArray(value) && value.length >= min && value.length <= max;
 }
@@ -112,6 +112,11 @@ export function limitArray(list, limit) {
 export function countArray(arr) {
     return arr.length;
 }
+export function interleaveArray(items, separator) {
+    if (isArray(items) && items.length < 2)
+        return items; // Return same empty array if empty or only one item.
+    return Array.from(interleaveItems(items, separator));
+}
 /** Get the first item from an array or iterable, or `undefined` if it didn't exist. */
 export function getFirst(items) {
     if (isArray(items))

package/util/iterate.d.ts

@@ -34,3 +34,6 @@ export declare function reduceItems<I, O>(items: Iterable<I>, reducer: (previous
 export declare function getChunks<T>(items: Iterable<T>, size: number): Iterable<readonly T[]>;
 /** Merge two or more iterables into a single iterable set. */
 export declare function mergeItems<T>(...inputs: [Iterable<T>, Iterable<T>, ...Iterable<T>[]]): Iterable<T>;
+/** Intersperse items with a separator */
+export declare function interleaveItems<T>(items: Iterable<T>, separator: T): Iterable<T>;
+export declare function interleaveItems<A, B>(items: Iterable<A>, separator: B): Iterable<A | B>;

package/util/iterate.js

@@ -87,3 +87,12 @@ export function* mergeItems(...inputs) {
     for (const input of inputs)
         yield* input;
 }
+export function* interleaveItems(items, separator) {
+    let first = true;
+    for (const item of items) {
+        if (!first)
+            yield separator;
+        yield item;
+        first = false;
+    }
+}