dce-commonkit 4.4.0

package/lib/helpers/asyncArrayFunctions/everyAsync.test.js

@@ -0,0 +1,219 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Import item to test
+var everyAsync_1 = __importDefault(require("./everyAsync"));
+describe('everyAsync', function () {
+    it('returns true for an empty array', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, (0, everyAsync_1.default)([], function () { return __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            return [2 /*return*/, true];
+                        });
+                    }); })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toBe(true);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('returns true if the operator function returns true for every item in the array', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, (0, everyAsync_1.default)([1, 2, 3], function (item) { return __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            return [2 /*return*/, item > 0];
+                        });
+                    }); })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toBe(true);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('returns false if the operator function returns false for any item in the array', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, (0, everyAsync_1.default)([1, 2, 3], function (item) { return __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            return [2 /*return*/, item > 1];
+                        });
+                    }); })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toBe(false);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('passes the index as the second argument to the operator function', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, (0, everyAsync_1.default)([1, 2, 3], function (item, index) { return __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            return [2 /*return*/, index === item - 1];
+                        });
+                    }); })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toBe(true);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('passes an object with a breakNow function and the array as the third argument to the operator function', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, (0, everyAsync_1.default)([1, 2, 3], function (item_1, index_1, _a) { return __awaiter(void 0, [item_1, index_1, _a], void 0, function (item, index, _b) {
+                        var breakNow = _b.breakNow;
+                        return __generator(this, function (_c) {
+                            if (item === 2) {
+                                breakNow();
+                            }
+                            return [2 /*return*/, true];
+                        });
+                    }); })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toBe(false);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('stops iterating if the operator function calls the breakNow function', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var mockOperatorFunction, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    mockOperatorFunction = jest.fn(function (item_1, index_1, _a) { return __awaiter(void 0, [item_1, index_1, _a], void 0, function (item, index, _b) {
+                        var breakNow = _b.breakNow;
+                        return __generator(this, function (_c) {
+                            if (item === 2) {
+                                breakNow();
+                            }
+                            return [2 /*return*/, true];
+                        });
+                    }); });
+                    return [4 /*yield*/, (0, everyAsync_1.default)([1, 2, 3], mockOperatorFunction)];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toBe(false);
+                    expect(mockOperatorFunction).toHaveBeenCalledTimes(2);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('handles an operator function that returns a promise that resolves to true', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, (0, everyAsync_1.default)([1, 2, 3], function (item) { return __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            return [2 /*return*/, Promise.resolve(item > 0)];
+                        });
+                    }); })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toBe(true);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('handles an operator function that returns a promise that resolves to false', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, (0, everyAsync_1.default)([1, 2, 3], function (item) { return __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            return [2 /*return*/, Promise.resolve(item > 1)];
+                        });
+                    }); })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toBe(false);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('handles an operator function that throws an error', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var mockOperatorFunction, error, result, err_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    mockOperatorFunction = jest.fn(function (item) { return __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            if (item === 2) {
+                                throw new Error('Test error');
+                            }
+                            return [2 /*return*/, true];
+                        });
+                    }); });
+                    error = null;
+                    result = null;
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 3, , 4]);
+                    return [4 /*yield*/, (0, everyAsync_1.default)([1, 2, 3], mockOperatorFunction)];
+                case 2:
+                    result = _a.sent();
+                    return [3 /*break*/, 4];
+                case 3:
+                    err_1 = _a.sent();
+                    error = err_1;
+                    return [3 /*break*/, 4];
+                case 4:
+                    expect(result).toBe(null);
+                    expect(error).not.toBe(null);
+                    expect(mockOperatorFunction).toHaveBeenCalledTimes(2);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});
+//# sourceMappingURL=everyAsync.test.js.map

package/lib/helpers/asyncArrayFunctions/everyAsync.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"everyAsync.test.js","sourceRoot":"","sources":["../../../src/helpers/asyncArrayFunctions/everyAsync.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,sBAAsB;AACtB,4DAAsC;AAEtC,QAAQ,CAAC,YAAY,EAAE;IACrB,EAAE,CAAC,iCAAiC,EAAE;;;;wBACrB,qBAAM,IAAA,oBAAU,EAC7B,EAAE,EACF;;4BACE,sBAAO,IAAI,EAAC;;yBACb,CACF,EAAA;;oBALK,MAAM,GAAG,SAKd;oBACD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;;;;SAC3B,CAAC,CAAC;IAEH,EAAE,CAAC,gFAAgF,EAAE;;;;wBACpE,qBAAM,IAAA,oBAAU,EAC7B,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACT,UAAO,IAAI;;4BACT,sBAAO,IAAI,GAAG,CAAC,EAAC;;yBACjB,CACF,EAAA;;oBALK,MAAM,GAAG,SAKd;oBACD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;;;;SAC3B,CAAC,CAAC;IAEH,EAAE,CAAC,gFAAgF,EAAE;;;;wBACpE,qBAAM,IAAA,oBAAU,EAC7B,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACT,UAAO,IAAI;;4BACT,sBAAO,IAAI,GAAG,CAAC,EAAC;;yBACjB,CACF,EAAA;;oBALK,MAAM,GAAG,SAKd;oBACD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;;;;SAC5B,CAAC,CAAC;IAEH,EAAE,CAAC,kEAAkE,EAAE;;;;wBACtD,qBAAM,IAAA,oBAAU,EAC7B,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACT,UAAO,IAAI,EAAE,KAAK;;4BAChB,sBAAO,KAAK,KAAK,IAAI,GAAG,CAAC,EAAC;;yBAC3B,CACF,EAAA;;oBALK,MAAM,GAAG,SAKd;oBACD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;;;;SAC3B,CAAC,CAAC;IAEH,EAAE,CAAC,wGAAwG,EAAE;;;;wBAC5F,qBAAM,IAAA,oBAAU,EAC7B,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACT,mGAAO,IAAI,EAAE,KAAK,EAAE,EAAY;4BAAV,QAAQ,cAAA;;4BAC5B,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;gCACf,QAAQ,EAAE,CAAC;4BACb,CAAC;4BACD,sBAAO,IAAI,EAAC;;yBACb,CACF,EAAA;;oBARK,MAAM,GAAG,SAQd;oBACD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;;;;SAC5B,CAAC,CAAC;IAEH,EAAE,CAAC,sEAAsE,EAAE;;;;;oBACnE,oBAAoB,GAAG,IAAI,CAAC,EAAE,CAAC,mGAAO,IAAI,EAAE,KAAK,EAAE,EAAY;4BAAV,QAAQ,cAAA;;4BACjE,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;gCACf,QAAQ,EAAE,CAAC;4BACb,CAAC;4BACD,sBAAO,IAAI,EAAC;;yBACb,CAAC,CAAC;oBACY,qBAAM,IAAA,oBAAU,EAC7B,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACT,oBAAoB,CACrB,EAAA;;oBAHK,MAAM,GAAG,SAGd;oBACD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBAC3B,MAAM,CAAC,oBAAoB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;;;;SACvD,CAAC,CAAC;IAEH,EAAE,CAAC,2EAA2E,EAAE;;;;wBAC/D,qBAAM,IAAA,oBAAU,EAC7B,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACT,UAAO,IAAI;;4BACT,sBAAO,OAAO,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC,EAAC;;yBAClC,CACF,EAAA;;oBALK,MAAM,GAAG,SAKd;oBACD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;;;;SAC3B,CAAC,CAAC;IAEH,EAAE,CAAC,4EAA4E,EAAE;;;;wBAChE,qBAAM,IAAA,oBAAU,EAC7B,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACT,UAAO,IAAI;;4BACT,sBAAO,OAAO,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC,EAAC;;yBAClC,CACF,EAAA;;oBALK,MAAM,GAAG,SAKd;oBACD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;;;;SAC5B,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE;;;;;oBAChD,oBAAoB,GAAG,IAAI,CAAC,EAAE,CAAC,UAAO,IAAI;;4BAC9C,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;gCACf,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;4BAChC,CAAC;4BACD,sBAAO,IAAI,EAAC;;yBACb,CAAC,CAAC;oBACC,KAAK,GAAQ,IAAI,CAAC;oBAClB,MAAM,GAAmB,IAAI,CAAC;;;;oBAEvB,qBAAM,IAAA,oBAAU,EACvB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACT,oBAAoB,CACrB,EAAA;;oBAHD,MAAM,GAAG,SAGR,CAAC;;;;oBAEF,KAAK,GAAG,KAAG,CAAC;;;oBAEd,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBAC1B,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBAC7B,MAAM,CAAC,oBAAoB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;;;;SACvD,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/helpers/asyncArrayFunctions/filterAsync.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Run the operator function on each item in the array, returning a new array
+ *   that only contains the items that pass the filter
+ * @author Gabe Abrams
+ * @param operatorFunction the operator function to apply. If it returns true
+ *   for an item, the item will be included in the returned array
+ * @returns the filtered array
+ */
+declare const filterAsync: <T>(array: T[], operatorFunction: (item: T, index: number, opts: {
+    breakNow: () => void;
+    array: Array<T>;
+}) => Promise<any>) => Promise<T[]>;
+export default filterAsync;

package/lib/helpers/asyncArrayFunctions/filterAsync.js

@@ -0,0 +1,81 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Run the operator function on each item in the array, returning a new array
+ *   that only contains the items that pass the filter
+ * @author Gabe Abrams
+ * @param operatorFunction the operator function to apply. If it returns true
+ *   for an item, the item will be included in the returned array
+ * @returns the filtered array
+ */
+var filterAsync = function (array, operatorFunction) { return __awaiter(void 0, void 0, void 0, function () {
+    var done, breakNow, output, i, included;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                done = false;
+                breakNow = function () {
+                    done = true;
+                };
+                output = [];
+                i = 0;
+                _a.label = 1;
+            case 1:
+                if (!(i < array.length && !done)) return [3 /*break*/, 4];
+                return [4 /*yield*/, operatorFunction(array[i], i, {
+                        breakNow: breakNow,
+                        array: array,
+                    })];
+            case 2:
+                included = _a.sent();
+                if (included && !done) {
+                    output.push(array[i]);
+                }
+                _a.label = 3;
+            case 3:
+                i++;
+                return [3 /*break*/, 1];
+            case 4: 
+            // Return results
+            return [2 /*return*/, output];
+        }
+    });
+}); };
+exports.default = filterAsync;
+//# sourceMappingURL=filterAsync.js.map

package/lib/helpers/asyncArrayFunctions/filterAsync.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filterAsync.js","sourceRoot":"","sources":["../../../src/helpers/asyncArrayFunctions/filterAsync.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;GAOG;AACH,IAAM,WAAW,GAAG,UAClB,KAAU,EACV,gBAOiB;;;;;gBAGb,IAAI,GAAG,KAAK,CAAC;gBAKX,QAAQ,GAAG;oBACf,IAAI,GAAG,IAAI,CAAC;gBACd,CAAC,CAAC;gBAGI,MAAM,GAAQ,EAAE,CAAC;gBACd,CAAC,GAAG,CAAC;;;qBAAE,CAAA,CAAC,GAAG,KAAK,CAAC,MAAM,IAAI,CAAC,IAAI,CAAA;gBACtB,qBAAM,gBAAgB,CACrC,KAAK,CAAC,CAAC,CAAC,EACR,CAAC,EACD;wBACE,QAAQ,UAAA;wBACR,KAAK,OAAA;qBACN,CACF,EAAA;;gBAPK,QAAQ,GAAG,SAOhB;gBACD,IAAI,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;oBACtB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;gBACxB,CAAC;;;gBAXwC,CAAC,EAAE,CAAA;;;YAc9C,iBAAiB;YACjB,sBAAO,MAAM,EAAC;;;KACf,CAAC;AAEF,kBAAe,WAAW,CAAC"}

package/lib/helpers/asyncArrayFunctions/filterAsync.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/helpers/asyncArrayFunctions/filterAsync.test.js

@@ -0,0 +1,244 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var filterAsync_1 = __importDefault(require("./filterAsync"));
+describe('filterAsync', function () {
+    it('should return an empty array when given an empty array', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, (0, filterAsync_1.default)([], function () { return __awaiter(void 0, void 0, void 0, function () {
+                        return __generator(this, function (_a) {
+                            return [2 /*return*/, true];
+                        });
+                    }); })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toEqual([]);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('should return the original array when all items pass the filter', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var originalArray, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    originalArray = [1, 2, 3];
+                    return [4 /*yield*/, (0, filterAsync_1.default)(originalArray, function () { return __awaiter(void 0, void 0, void 0, function () {
+                            return __generator(this, function (_a) {
+                                return [2 /*return*/, true];
+                            });
+                        }); })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toEqual(originalArray);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('should return an empty array when no items pass the filter', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var originalArray, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    originalArray = [1, 2, 3];
+                    return [4 /*yield*/, (0, filterAsync_1.default)(originalArray, function () { return __awaiter(void 0, void 0, void 0, function () {
+                            return __generator(this, function (_a) {
+                                return [2 /*return*/, false];
+                            });
+                        }); })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toEqual([]);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('should return only the items that pass the filter', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var originalArray, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    originalArray = [1, 2, 3];
+                    return [4 /*yield*/, (0, filterAsync_1.default)(originalArray, function (item) { return __awaiter(void 0, void 0, void 0, function () {
+                            return __generator(this, function (_a) {
+                                return [2 /*return*/, item > 1];
+                            });
+                        }); })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toEqual([2, 3]);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('should pass the correct index to the operator function', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var originalArray, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    originalArray = [1, 2, 3];
+                    return [4 /*yield*/, (0, filterAsync_1.default)(originalArray, function (_, index) { return __awaiter(void 0, void 0, void 0, function () {
+                            return __generator(this, function (_a) {
+                                return [2 /*return*/, index === 1];
+                            });
+                        }); })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toEqual([2]);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('should allow breaking out of the loop early', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var originalArray, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    originalArray = [1, 2, 3];
+                    return [4 /*yield*/, (0, filterAsync_1.default)(originalArray, function (_1, index_1, _a) { return __awaiter(void 0, [_1, index_1, _a], void 0, function (_, index, _b) {
+                            var breakNow = _b.breakNow;
+                            return __generator(this, function (_c) {
+                                if (index === 1) {
+                                    breakNow();
+                                }
+                                return [2 /*return*/, true];
+                            });
+                        }); })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toEqual([1]);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('should pass the original array to the operator function', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var originalArray, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    originalArray = [1, 2, 3];
+                    return [4 /*yield*/, (0, filterAsync_1.default)(originalArray, function (_1, index_1, _a) { return __awaiter(void 0, [_1, index_1, _a], void 0, function (_, index, _b) {
+                            var array = _b.array;
+                            return __generator(this, function (_c) {
+                                return [2 /*return*/, array.length === 3];
+                            });
+                        }); })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toEqual(originalArray);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('should handle an operator function that returns a non-boolean value', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var originalArray, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    originalArray = [1, 2, 3];
+                    return [4 /*yield*/, (0, filterAsync_1.default)(originalArray, function () { return __awaiter(void 0, void 0, void 0, function () {
+                            return __generator(this, function (_a) {
+                                return [2 /*return*/, 'hello'];
+                            });
+                        }); })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toEqual(originalArray);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('should handle an operator function that throws an error', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var originalArray, error, result, err_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    originalArray = [1, 2, 3];
+                    error = null;
+                    result = null;
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, 3, , 4]);
+                    return [4 /*yield*/, (0, filterAsync_1.default)(originalArray, function () { return __awaiter(void 0, void 0, void 0, function () {
+                            return __generator(this, function (_a) {
+                                throw new Error('Something went wrong');
+                            });
+                        }); })];
+                case 2:
+                    result = _a.sent();
+                    return [3 /*break*/, 4];
+                case 3:
+                    err_1 = _a.sent();
+                    error = err_1;
+                    return [3 /*break*/, 4];
+                case 4:
+                    expect(result).toEqual(null);
+                    expect(error).not.toBe(null);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('should handle an array of objects', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var originalArray, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    originalArray = [
+                        { name: 'Alice', age: 30 },
+                        { name: 'Bob', age: 25 },
+                        { name: 'Charlie', age: 35 },
+                    ];
+                    return [4 /*yield*/, (0, filterAsync_1.default)(originalArray, function (item) { return __awaiter(void 0, void 0, void 0, function () {
+                            return __generator(this, function (_a) {
+                                return [2 /*return*/, (item.age > 30)];
+                            });
+                        }); })];
+                case 1:
+                    result = _a.sent();
+                    expect(result).toEqual([{ name: 'Charlie', age: 35 }]);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});
+//# sourceMappingURL=filterAsync.test.js.map

package/lib/helpers/asyncArrayFunctions/filterAsync.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filterAsync.test.js","sourceRoot":"","sources":["../../../src/helpers/asyncArrayFunctions/filterAsync.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,8DAAwC;AAExC,QAAQ,CAAC,aAAa,EAAE;IACtB,EAAE,CAAC,wDAAwD,EAAE;;;;wBAC5C,qBAAM,IAAA,qBAAW,EAC9B,EAAE,EACF;;4BACE,sBAAO,IAAI,EAAC;;yBACb,CACF,EAAA;;oBALK,MAAM,GAAG,SAKd;oBACD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;;;;SAC5B,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE;;;;;oBAC9D,aAAa,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;oBACjB,qBAAM,IAAA,qBAAW,EAC9B,aAAa,EACb;;gCACE,sBAAO,IAAI,EAAC;;6BACb,CACF,EAAA;;oBALK,MAAM,GAAG,SAKd;oBACD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;;;;SACvC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE;;;;;oBACzD,aAAa,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;oBACjB,qBAAM,IAAA,qBAAW,EAC9B,aAAa,EACb;;gCACE,sBAAO,KAAK,EAAC;;6BACd,CACF,EAAA;;oBALK,MAAM,GAAG,SAKd;oBACD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;;;;SAC5B,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE;;;;;oBAChD,aAAa,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;oBACjB,qBAAM,IAAA,qBAAW,EAC9B,aAAa,EACb,UAAO,IAAI;;gCACT,sBAAO,IAAI,GAAG,CAAC,EAAC;;6BACjB,CACF,EAAA;;oBALK,MAAM,GAAG,SAKd;oBACD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;;;;SAChC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE;;;;;oBACrD,aAAa,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;oBACjB,qBAAM,IAAA,qBAAW,EAC9B,aAAa,EACb,UAAO,CAAC,EAAE,KAAK;;gCACb,sBAAO,KAAK,KAAK,CAAC,EAAC;;6BACpB,CACF,EAAA;;oBALK,MAAM,GAAG,SAKd;oBACD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;;;;SAC7B,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE;;;;;oBAC1C,aAAa,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;oBACjB,qBAAM,IAAA,qBAAW,EAC9B,aAAa,EACb,2FAAO,CAAC,EAAE,KAAK,EAAE,EAAY;gCAAV,QAAQ,cAAA;;gCACzB,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;oCAChB,QAAQ,EAAE,CAAC;gCACb,CAAC;gCACD,sBAAO,IAAI,EAAC;;6BACb,CACF,EAAA;;oBARK,MAAM,GAAG,SAQd;oBACD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;;;;SAC7B,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE;;;;;oBACtD,aAAa,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;oBACjB,qBAAM,IAAA,qBAAW,EAC9B,aAAa,EACb,2FAAO,CAAC,EAAE,KAAK,EAAE,EAAS;gCAAP,KAAK,WAAA;;gCACtB,sBAAO,KAAK,CAAC,MAAM,KAAK,CAAC,EAAC;;6BAC3B,CACF,EAAA;;oBALK,MAAM,GAAG,SAKd;oBACD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;;;;SACvC,CAAC,CAAC;IAEH,EAAE,CAAC,qEAAqE,EAAE;;;;;oBAClE,aAAa,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;oBACjB,qBAAM,IAAA,qBAAW,EAC9B,aAAa,EACb;;gCACE,sBAAO,OAAO,EAAC;;6BAChB,CACF,EAAA;;oBALK,MAAM,GAAG,SAKd;oBACD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;;;;SACvC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE;;;;;oBACtD,aAAa,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;oBAC5B,KAAK,GAAQ,IAAI,CAAC;oBAClB,MAAM,GAAoB,IAAI,CAAC;;;;oBAExB,qBAAM,IAAA,qBAAW,EACxB,aAAa,EACb;;gCACE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;;6BACzC,CACF,EAAA;;oBALD,MAAM,GAAG,SAKR,CAAC;;;;oBAEF,KAAK,GAAG,KAAG,CAAC;;;oBAEd,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;oBAC7B,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;;;;SAC9B,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE;;;;;oBAChC,aAAa,GAAG;wBACpB,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE;wBAC1B,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE;wBACxB,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,EAAE,EAAE;qBAC7B,CAAC;oBACa,qBAAM,IAAA,qBAAW,EAC9B,aAAa,EACb,UAAO,IAAI;;gCACT,sBAAO,CAAC,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC,EAAC;;6BACxB,CACF,EAAA;;oBALK,MAAM,GAAG,SAKd;oBACD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;;;;SACxD,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/helpers/asyncArrayFunctions/forEachAsync.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Run the operator function on each item in the array
+ * @author Gabe Abrams
+ * @param operatorFunction the operator function to apply
+ */
+declare const forEachAsync: <T>(array: T[], operatorFunction: (item: T, index: number, opts: {
+    breakNow: () => void;
+    array: Array<T>;
+}) => void) => Promise<void>;
+export default forEachAsync;