@cspell/cspell-pipe 6.6.1 → 6.7.0

package/dist/helpers/distribute.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Allows an iterable to be shared by multiple consumers.
+ * Each consumer takes from the iterable.
+ * @param iterable - the iterable to share
+ */
+export declare function toDistributableIterableSync<T>(iterable: Iterable<T>): Iterable<T>;
+/**
+ * Allows an iterable to be shared by multiple consumers.
+ * Each consumer takes from the iterable.
+ * @param iterable - the iterable to share
+ */
+export declare const toDistributableIterable: typeof toDistributableIterableSync;
+//# sourceMappingURL=distribute.d.ts.map

package/dist/helpers/distribute.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toDistributableIterable = exports.toDistributableIterableSync = void 0;
+/**
+ * Allows an iterable to be shared by multiple consumers.
+ * Each consumer takes from the iterable.
+ * @param iterable - the iterable to share
+ */
+function toDistributableIterableSync(iterable) {
+    let lastValue;
+    let iter;
+    function getNext() {
+        if (lastValue && lastValue.done) {
+            return { ...lastValue };
+        }
+        iter = iter || iterable[Symbol.iterator]();
+        lastValue = iter.next();
+        return lastValue;
+    }
+    function* iterableFn() {
+        let next;
+        while (!(next = getNext()).done) {
+            yield next.value;
+        }
+    }
+    return {
+        [Symbol.iterator]: iterableFn,
+    };
+}
+exports.toDistributableIterableSync = toDistributableIterableSync;
+/**
+ * Allows an iterable to be shared by multiple consumers.
+ * Each consumer takes from the iterable.
+ * @param iterable - the iterable to share
+ */
+exports.toDistributableIterable = toDistributableIterableSync;
+//# sourceMappingURL=distribute.js.map

package/dist/helpers/index.d.ts

@@ -1,4 +1,6 @@
 export { toAsyncIterable } from './toAsyncIterable';
 export { isAsyncIterable } from './util';
 export { toArray } from './toArray';
+export { toDistributableIterable } from './distribute';
+export { interleave } from './interleave';
 //# sourceMappingURL=index.d.ts.map

package/dist/helpers/index.js

@@ -1,10 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toArray = exports.isAsyncIterable = exports.toAsyncIterable = void 0;
+exports.interleave = exports.toDistributableIterable = exports.toArray = exports.isAsyncIterable = exports.toAsyncIterable = void 0;
 var toAsyncIterable_1 = require("./toAsyncIterable");
 Object.defineProperty(exports, "toAsyncIterable", { enumerable: true, get: function () { return toAsyncIterable_1.toAsyncIterable; } });
 var util_1 = require("./util");
 Object.defineProperty(exports, "isAsyncIterable", { enumerable: true, get: function () { return util_1.isAsyncIterable; } });
 var toArray_1 = require("./toArray");
 Object.defineProperty(exports, "toArray", { enumerable: true, get: function () { return toArray_1.toArray; } });
+var distribute_1 = require("./distribute");
+Object.defineProperty(exports, "toDistributableIterable", { enumerable: true, get: function () { return distribute_1.toDistributableIterable; } });
+var interleave_1 = require("./interleave");
+Object.defineProperty(exports, "interleave", { enumerable: true, get: function () { return interleave_1.interleave; } });
 //# sourceMappingURL=index.js.map

package/dist/helpers/interleave.d.ts

@@ -0,0 +1,2 @@
+export declare function interleave<T>(a: Iterable<T>, b: Iterable<T>): Iterable<T>;
+//# sourceMappingURL=interleave.d.ts.map

package/dist/helpers/interleave.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.interleave = void 0;
+function* interleave(a, b) {
+    const ai = a[Symbol.iterator]();
+    const bi = b[Symbol.iterator]();
+    for (let aNext = ai.next(); !aNext.done; aNext = ai.next()) {
+        yield aNext.value;
+        const bNext = bi.next();
+        if (bNext.done)
+            break;
+        yield bNext.value;
+    }
+    for (let aNext = ai.next(); !aNext.done; aNext = ai.next()) {
+        yield aNext.value;
+    }
+    for (let bNext = bi.next(); !bNext.done; bNext = bi.next()) {
+        yield bNext.value;
+    }
+}
+exports.interleave = interleave;
+//# sourceMappingURL=interleave.js.map

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as _helpers from './helpers';
 import * as _operators from './operators';
-export { isAsyncIterable, toArray, toAsyncIterable } from './helpers';
-export { opAwaitAsync, opConcatMap, opFilter, opFlatten, opJoinStrings, opMap, opSkip, opTake, opTap, opUnique, } from './operators';
+export { interleave, isAsyncIterable, toArray, toAsyncIterable, toDistributableIterable } from './helpers';
+export { opAppend, opAwaitAsync, opConcatMap, opFilter, opFlatten, opJoinStrings, opMap, opSkip, opTake, opTap, opUnique, } from './operators';
 export { pipeAsync, pipeSync } from './pipe';
 export declare const operators: typeof _operators;
 export declare const helpers: typeof _helpers;

package/dist/index.js

@@ -23,14 +23,17 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.helpers = exports.operators = exports.pipeSync = exports.pipeAsync = exports.opUnique = exports.opTap = exports.opTake = exports.opSkip = exports.opMap = exports.opJoinStrings = exports.opFlatten = exports.opFilter = exports.opConcatMap = exports.opAwaitAsync = exports.toAsyncIterable = exports.toArray = exports.isAsyncIterable = void 0;
+exports.helpers = exports.operators = exports.pipeSync = exports.pipeAsync = exports.opUnique = exports.opTap = exports.opTake = exports.opSkip = exports.opMap = exports.opJoinStrings = exports.opFlatten = exports.opFilter = exports.opConcatMap = exports.opAwaitAsync = exports.opAppend = exports.toDistributableIterable = exports.toAsyncIterable = exports.toArray = exports.isAsyncIterable = exports.interleave = void 0;
 const _helpers = __importStar(require("./helpers"));
 const _operators = __importStar(require("./operators"));
 var helpers_1 = require("./helpers");
+Object.defineProperty(exports, "interleave", { enumerable: true, get: function () { return helpers_1.interleave; } });
 Object.defineProperty(exports, "isAsyncIterable", { enumerable: true, get: function () { return helpers_1.isAsyncIterable; } });
 Object.defineProperty(exports, "toArray", { enumerable: true, get: function () { return helpers_1.toArray; } });
 Object.defineProperty(exports, "toAsyncIterable", { enumerable: true, get: function () { return helpers_1.toAsyncIterable; } });
+Object.defineProperty(exports, "toDistributableIterable", { enumerable: true, get: function () { return helpers_1.toDistributableIterable; } });
 var operators_1 = require("./operators");
+Object.defineProperty(exports, "opAppend", { enumerable: true, get: function () { return operators_1.opAppend; } });
 Object.defineProperty(exports, "opAwaitAsync", { enumerable: true, get: function () { return operators_1.opAwaitAsync; } });
 Object.defineProperty(exports, "opConcatMap", { enumerable: true, get: function () { return operators_1.opConcatMap; } });
 Object.defineProperty(exports, "opFilter", { enumerable: true, get: function () { return operators_1.opFilter; } });

package/dist/operators/append.d.ts

@@ -0,0 +1,15 @@
+import { PipeFn } from '../internalTypes';
+/**
+ * Append values onto the end of an iterable.
+ * @param iterablesToAppend - the iterables in the order to be appended.
+ * @returns
+ */
+export declare function opAppendAsync<T>(...iterablesToAppend: (AsyncIterable<T> | Iterable<T>)[]): (iter: AsyncIterable<T> | Iterable<T>) => AsyncIterable<T>;
+/**
+ * Append values onto the end of an iterable.
+ * @param iterablesToAppend - the iterables in the order to be appended.
+ * @returns
+ */
+export declare function opAppendSync<T>(...iterablesToAppend: Iterable<T>[]): (iter: Iterable<T>) => Iterable<T>;
+export declare function opAppend<T>(...iterablesToAppend: Iterable<T>[]): PipeFn<T, T>;
+//# sourceMappingURL=append.d.ts.map

package/dist/operators/append.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.opAppend = exports.opAppendSync = exports.opAppendAsync = void 0;
+const helpers_1 = require("../helpers");
+/**
+ * Append values onto the end of an iterable.
+ * @param iterablesToAppend - the iterables in the order to be appended.
+ * @returns
+ */
+function opAppendAsync(...iterablesToAppend) {
+    async function* fn(iter) {
+        yield* iter;
+        for (const i of iterablesToAppend) {
+            yield* i;
+        }
+    }
+    return fn;
+}
+exports.opAppendAsync = opAppendAsync;
+/**
+ * Append values onto the end of an iterable.
+ * @param iterablesToAppend - the iterables in the order to be appended.
+ * @returns
+ */
+function opAppendSync(...iterablesToAppend) {
+    function* fn(iter) {
+        yield* iter;
+        for (const i of iterablesToAppend) {
+            yield* i;
+        }
+    }
+    return fn;
+}
+exports.opAppendSync = opAppendSync;
+function opAppend(...iterablesToAppend) {
+    function _(i) {
+        return (0, helpers_1.isAsyncIterable)(i) ? opAppendAsync(...iterablesToAppend)(i) : opAppendSync(...iterablesToAppend)(i);
+    }
+    return _;
+}
+exports.opAppend = opAppend;
+//# sourceMappingURL=append.js.map

package/dist/operators/index.d.ts

@@ -1,3 +1,4 @@
+export { opAppend, opAppendAsync, opAppendSync } from './append';
 export { opAwaitAsync } from './await';
 export { opConcatMap, opConcatMapAsync, opConcatMapSync } from './concatMap';
 export { opFilter as opFilter, opFilterAsync, opFilterSync } from './filter';

package/dist/operators/index.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.opUniqueSync = exports.opUniqueAsync = exports.opUnique = exports.opTapSync = exports.opTapAsync = exports.opTap = exports.opTakeSync = exports.opTakeAsync = exports.opTake = exports.opSkipSync = exports.opSkipAsync = exports.opSkip = exports.opMapSync = exports.opMapAsync = exports.opMap = exports.opJoinStringsSync = exports.opJoinStringsAsync = exports.opJoinStrings = exports.opFlattenSync = exports.opFlattenAsync = exports.opFlatten = exports.opFilterSync = exports.opFilterAsync = exports.opFilter = exports.opConcatMapSync = exports.opConcatMapAsync = exports.opConcatMap = exports.opAwaitAsync = void 0;
+exports.opUniqueSync = exports.opUniqueAsync = exports.opUnique = exports.opTapSync = exports.opTapAsync = exports.opTap = exports.opTakeSync = exports.opTakeAsync = exports.opTake = exports.opSkipSync = exports.opSkipAsync = exports.opSkip = exports.opMapSync = exports.opMapAsync = exports.opMap = exports.opJoinStringsSync = exports.opJoinStringsAsync = exports.opJoinStrings = exports.opFlattenSync = exports.opFlattenAsync = exports.opFlatten = exports.opFilterSync = exports.opFilterAsync = exports.opFilter = exports.opConcatMapSync = exports.opConcatMapAsync = exports.opConcatMap = exports.opAwaitAsync = exports.opAppendSync = exports.opAppendAsync = exports.opAppend = void 0;
+var append_1 = require("./append");
+Object.defineProperty(exports, "opAppend", { enumerable: true, get: function () { return append_1.opAppend; } });
+Object.defineProperty(exports, "opAppendAsync", { enumerable: true, get: function () { return append_1.opAppendAsync; } });
+Object.defineProperty(exports, "opAppendSync", { enumerable: true, get: function () { return append_1.opAppendSync; } });
 var await_1 = require("./await");
 Object.defineProperty(exports, "opAwaitAsync", { enumerable: true, get: function () { return await_1.opAwaitAsync; } });
 var concatMap_1 = require("./concatMap");

package/dist/operators/joinStrings.js

@@ -23,6 +23,6 @@ function opJoinStringsSync(joinCharacter = ',') {
     return fn;
 }
 exports.opJoinStringsSync = opJoinStringsSync;
-const opJoinStrings = (joinCharacter = ',') => (0, util_1.toPipeFn)(opJoinStringsSync(joinCharacter), opJoinStringsAsync(joinCharacter));
+const opJoinStrings = (joinCharacter) => (0, util_1.toPipeFn)(opJoinStringsSync(joinCharacter), opJoinStringsAsync(joinCharacter));
 exports.opJoinStrings = opJoinStrings;
 //# sourceMappingURL=joinStrings.js.map

package/dist/operators/take.d.ts

@@ -1,4 +1,8 @@
 export declare function opTakeAsync<T>(count: number): (iter: AsyncIterable<T> | Iterable<T>) => AsyncIterable<T>;
 export declare function opTakeSync<T>(count: number): (iter: Iterable<T>) => Iterable<T>;
+/**
+ * Consume only the first `count` number from the iterable.
+ * @param count - number to take
+ */
 export declare const opTake: <T>(count: number) => import("../internalTypes").PipeFn<T, T>;
 //# sourceMappingURL=take.d.ts.map

package/dist/operators/take.js

@@ -28,6 +28,10 @@ function opTakeSync(count) {
     return fn;
 }
 exports.opTakeSync = opTakeSync;
+/**
+ * Consume only the first `count` number from the iterable.
+ * @param count - number to take
+ */
 const opTake = (count) => (0, util_1.toPipeFn)(opTakeSync(count), opTakeAsync(count));
 exports.opTake = opTake;
 //# sourceMappingURL=take.js.map

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "6.6.1",
+  "version": "6.7.0",
   "description": "Library to make working with Iterators/AsyncIterators easier.",
   "keywords": [
     "cspell",
@@ -93,9 +93,9 @@
     "node": ">=14"
   },
   "devDependencies": {
-    "@types/node": "^18.6.5",
+    "@types/node": "^18.7.6",
     "jest": "^28.1.3",
     "rimraf": "^3.0.2"
   },
-  "gitHead": "3c9c24d1cebd558ac3729d3fbf441e6ed751d8cf"
+  "gitHead": "3a7312a15d2df1507d9e01863ec5842f5a99e0cc"
 }