spliterator 5.0.0 → 6.0.1

package/out/lib/utils.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @copyright Sister Software
+ * @license MIT
+ * @author Teffen Ellis, et al.
+ */
+/**
+ * Convenience function to await an async iterable.
+ */
+export declare function iterateInParallel<T>(asyncIterable: AsyncIterable<T>): Promise<void>;
+/**
+ * Type-predicate for checking if a value is iterable.
+ *
+ * @category Type Guard
+ * @category Object
+ */
+export declare function isIterable<T>(input: unknown): input is Iterable<T>;
+/**
+ * Iterable that can be checked for the existence of a member.
+ */
+export interface IndexedIterable<T = unknown> extends Iterable<T> {
+    has(value: T): boolean;
+}
+/**
+ * Type-predicate for checking if an member within an iterable can be checked for existence.
+ */
+export declare function isIndexedIterable<T>(value: Iterable<T>): value is IndexedIterable<T>;
+/**
+ * Extracts the property keys of an object that are of type `number`.
+ */
+export type NumericProperties<T> = {
+    [K in keyof T]: T[K] extends number ? K : never;
+}[keyof T];
+/**
+ * Given an iterable of objects, returns the sum of the specified property.
+ */
+export declare function sumOf<T extends object>(iterable: Iterable<T>, prop: NumericProperties<T>): number;
+//# sourceMappingURL=utils.d.ts.map

package/out/lib/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../lib/utils.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,wBAAsB,iBAAiB,CAAC,CAAC,EAAE,aAAa,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAIzF;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,QAAQ,CAAC,CAAC,CAAC,CAElE;AAED;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC,GAAG,OAAO,CAAE,SAAQ,QAAQ,CAAC,CAAC,CAAC;IAChE,GAAG,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO,CAAA;CACtB;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,eAAe,CAAC,CAAC,CAAC,CAEpF;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI;KACjC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,CAAC,GAAG,KAAK;CAC/C,CAAC,MAAM,CAAC,CAAC,CAAA;AAEV;;GAEG;AACH,wBAAgB,KAAK,CAAC,CAAC,SAAS,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,MAAM,CAQjG"}

package/out/lib/utils.js

@@ -0,0 +1,39 @@
+/**
+ * @copyright Sister Software
+ * @license MIT
+ * @author Teffen Ellis, et al.
+ */
+/**
+ * Convenience function to await an async iterable.
+ */
+export async function iterateInParallel(asyncIterable) {
+    for await (const _ of asyncIterable) {
+        /* empty */
+    }
+}
+/**
+ * Type-predicate for checking if a value is iterable.
+ *
+ * @category Type Guard
+ * @category Object
+ */
+export function isIterable(input) {
+    return Symbol.iterator in new Object(input);
+}
+/**
+ * Type-predicate for checking if an member within an iterable can be checked for existence.
+ */
+export function isIndexedIterable(value) {
+    return value && typeof value.has === "function";
+}
+/**
+ * Given an iterable of objects, returns the sum of the specified property.
+ */
+export function sumOf(iterable, prop) {
+    let total = 0;
+    for (const item of iterable) {
+        total += item[prop];
+    }
+    return total;
+}
+//# sourceMappingURL=utils.js.map

package/out/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../lib/utils.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CAAI,aAA+B;IACzE,IAAI,KAAK,EAAE,MAAM,CAAC,IAAI,aAAa,EAAE,CAAC;QACrC,WAAW;IACZ,CAAC;AACF,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAI,KAAc;IAC3C,OAAO,MAAM,CAAC,QAAQ,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,CAAA;AAC5C,CAAC;AASD;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAI,KAAkB;IACtD,OAAO,KAAK,IAAI,OAAQ,KAAyB,CAAC,GAAG,KAAK,UAAU,CAAA;AACrE,CAAC;AASD;;GAEG;AACH,MAAM,UAAU,KAAK,CAAmB,QAAqB,EAAE,IAA0B;IACxF,IAAI,KAAK,GAAG,CAAC,CAAA;IAEb,KAAK,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;QAC7B,KAAK,IAAI,IAAI,CAAC,IAAI,CAAW,CAAA;IAC9B,CAAC;IAED,OAAO,KAAK,CAAA;AACb,CAAC"}

package/out/lib/zip.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @copyright Sister Software
+ * @license MIT
+ * @author Teffen Ellis, et al.
+ */
+export type Zipped<T, U> = [a: T | undefined, b: U | undefined, idx: number];
+export type ZippedEntries<Z> = Z extends Zipped<infer T, infer U> ? [T, U] : never;
+export declare function zippedEntries<T, U>(zipped: Zipped<T, U>): ZippedEntries<Zipped<T, U>>;
+/**
+ * Given two iterables, zip them together into a single iterable which yields pairs of elements.
+ *
+ * If one iterable is longer than the other, the shorter iterable will be padded with `undefined`.
+ *
+ * @param a The first iterable to zip.
+ * @param b The second iterable to zip.
+ *
+ * @yields Pairs of elements from the two iterables.
+ * @see {@linkcode zipAsync} for the asynchronous version.
+ */
+export declare function zipSync<T, U>(a: Iterable<T>, b: Iterable<U>): Generator<Zipped<T, U>>;
+/**
+ * Given two iterables, zip them together into a single iterable which yields pairs of elements.
+ *
+ * If one iterable is longer than the other, the shorter iterable will be padded with `undefined`.
+ *
+ * @param a The first iterable to zip.
+ * @param b The second iterable to zip.
+ *
+ * @yields Pairs of elements from the two iterables.
+ * @see {@linkcode zipSync} for the synchronous version.
+ */
+export declare function zipAsync<T, U>(a: AsyncIterable<T> | Iterable<T>, b: AsyncIterable<U> | Iterable<U>): AsyncGenerator<[a: T | undefined, b: U | undefined, idx: number]>;
+//# sourceMappingURL=zip.d.ts.map

package/out/lib/zip.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"zip.d.ts","sourceRoot":"","sources":["../../lib/zip.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,MAAM,CAAC,CAAA;AAE5E,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAA;AAElF,wBAAgB,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAErF;AAED;;;;;;;;;;GAUG;AACH,wBAAiB,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAkBtF;AAED;;;;;;;;;;GAUG;AACH,wBAAuB,QAAQ,CAAC,CAAC,EAAE,CAAC,EACnC,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,EACjC,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,GAC/B,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,CAkBnE"}

package/out/lib/zip.js

@@ -0,0 +1,59 @@
+/**
+ * @copyright Sister Software
+ * @license MIT
+ * @author Teffen Ellis, et al.
+ */
+export function zippedEntries(zipped) {
+    return zipped.slice(0, 2);
+}
+/**
+ * Given two iterables, zip them together into a single iterable which yields pairs of elements.
+ *
+ * If one iterable is longer than the other, the shorter iterable will be padded with `undefined`.
+ *
+ * @param a The first iterable to zip.
+ * @param b The second iterable to zip.
+ *
+ * @yields Pairs of elements from the two iterables.
+ * @see {@linkcode zipAsync} for the asynchronous version.
+ */
+export function* zipSync(a, b) {
+    const aIterator = a[Symbol.iterator]();
+    const bIterator = b[Symbol.iterator]();
+    let index = 0;
+    while (true) {
+        const { done: aDone, value: aValue } = aIterator.next();
+        const { done: bDone, value: bValue } = bIterator.next();
+        if (aDone && bDone) {
+            break;
+        }
+        yield [aValue, bValue, index];
+        index++;
+    }
+}
+/**
+ * Given two iterables, zip them together into a single iterable which yields pairs of elements.
+ *
+ * If one iterable is longer than the other, the shorter iterable will be padded with `undefined`.
+ *
+ * @param a The first iterable to zip.
+ * @param b The second iterable to zip.
+ *
+ * @yields Pairs of elements from the two iterables.
+ * @see {@linkcode zipSync} for the synchronous version.
+ */
+export async function* zipAsync(a, b) {
+    const aIterator = Symbol.asyncIterator in a ? a[Symbol.asyncIterator]() : a[Symbol.iterator]();
+    const bIterator = Symbol.asyncIterator in b ? b[Symbol.asyncIterator]() : b[Symbol.iterator]();
+    let index = 0;
+    while (true) {
+        const { done: aDone, value: aValue } = await aIterator.next();
+        const { done: bDone, value: bValue } = await bIterator.next();
+        if (aDone && bDone) {
+            break;
+        }
+        yield [aValue, bValue, index];
+        index++;
+    }
+}
+//# sourceMappingURL=zip.js.map

package/out/lib/zip.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zip.js","sourceRoot":"","sources":["../../lib/zip.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAMH,MAAM,UAAU,aAAa,CAAO,MAAoB;IACvD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAgC,CAAA;AACzD,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,SAAS,CAAC,CAAC,OAAO,CAAO,CAAc,EAAE,CAAc;IAC5D,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAA;IACtC,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAA;IAEtC,IAAI,KAAK,GAAG,CAAC,CAAA;IAEb,OAAO,IAAI,EAAE,CAAC;QACb,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC,IAAI,EAAE,CAAA;QACvD,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC,IAAI,EAAE,CAAA;QAEvD,IAAI,KAAK,IAAI,KAAK,EAAE,CAAC;YACpB,MAAK;QACN,CAAC;QAED,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,CAAA;QAE7B,KAAK,EAAE,CAAA;IACR,CAAC;AACF,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC,QAAQ,CAC9B,CAAiC,EACjC,CAAiC;IAEjC,MAAM,SAAS,GAAG,MAAM,CAAC,aAAa,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAA;IAC9F,MAAM,SAAS,GAAG,MAAM,CAAC,aAAa,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAA;IAE9F,IAAI,KAAK,GAAG,CAAC,CAAA;IAEb,OAAO,IAAI,EAAE,CAAC;QACb,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,CAAA;QAC7D,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,CAAA;QAE7D,IAAI,KAAK,IAAI,KAAK,EAAE,CAAC;YACpB,MAAK;QACN,CAAC;QAED,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,CAAA;QAE7B,KAAK,EAAE,CAAA;IACR,CAAC;AACF,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "spliterator",
-	"version": "5.0.0",
+	"version": "6.0.1",
 	"description": "Line-delimited iterator library for CSV, NDJSON, and other delimited formats.",
 	"keywords": [
 		"csv",
@@ -65,15 +65,15 @@
 		"test": "yarn compile && vitest"
 	},
 	"devDependencies": {
-		"@sister.software/oxfmt-config": "^11.0.0",
-		"@sister.software/oxlint-config": "^11.0.0",
-		"@sister.software/tsconfig": "^11.0.0",
+		"@sister.software/oxfmt-config": "^12.1.3",
+		"@sister.software/oxlint-config": "^12.1.3",
+		"@sister.software/tsconfig": "^12.1.3",
 		"@types/node": "^26.1.2",
 		"change-case": "^5.4.4",
 		"colorette": "^2.0.20",
 		"npm-run-all": "^4.1.5",
-		"oxfmt": "0.61.0",
-		"oxlint": "1.76.0",
+		"oxfmt": "0.62.0",
+		"oxlint": "1.77.0",
 		"path-ts": "^2.1.0",
 		"release-it": "^21.0.1",
 		"type-fest": "^5.8.0",