dce-reactkit 3.7.3 → 3.7.5

package/dist/esm/types/components/Modal.d.ts

@@ -14,6 +14,7 @@ type Props = {
     children?: React.ReactNode;
     onClose?: (type: ModalButtonType) => void;
     dontAllowBackdropExit?: boolean;
+    dontShowXButton?: boolean;
     okayLabel?: string;
     okayVariant?: Variant;
     cancelLabel?: string;

package/dist/esm/types/components/Shimmer.d.ts

@@ -0,0 +1,13 @@
+/**
+ * A shimmer effect to add to the background of an element. The parent of this element
+ *   will automatically have its overflow hidden
+ * @author Alessandra De Lucas
+ * @author Gabe Abrams
+ */
+import React from 'react';
+type Props = {
+    durationSec?: number;
+    numShimmers?: number;
+};
+declare const Shimmer: React.FC<Props>;
+export default Shimmer;

package/dist/esm/types/helpers/asyncArrayFunctions/everyAsync.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Run the operator function on each item in the array, returning true if
+ *   the operator function returns true for every item in the array
+ * @author Gabe Abrams
+ * @param operatorFunction the operator function to apply. If it returns true
+ *   for every item, this function will return true
+ * @returns true if the operator function returns true for every item in the array
+ */
+declare const everyAsync: <T>(array: T[], operatorFunction: (item: T, index: number, opts: {
+    breakNow: () => void;
+    array: T[];
+}) => Promise<any>) => Promise<boolean>;
+export default everyAsync;

package/dist/esm/types/helpers/asyncArrayFunctions/everyAsync.test.d.ts

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

package/dist/esm/types/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: T[];
+}) => Promise<any>) => Promise<T[]>;
+export default filterAsync;

package/dist/esm/types/helpers/asyncArrayFunctions/filterAsync.test.d.ts

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

package/dist/esm/types/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: T[];
+}) => void) => Promise<void>;
+export default forEachAsync;

package/dist/esm/types/helpers/asyncArrayFunctions/forEachAsync.test.d.ts

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

package/dist/esm/types/helpers/asyncArrayFunctions/mapAsync.d.ts

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

package/dist/esm/types/helpers/asyncArrayFunctions/mapAsync.test.d.ts

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

package/dist/esm/types/helpers/asyncArrayFunctions/someAsync.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Run the operator function on each item in the array, returning true if
+ *   the operator function returns true for any item in the array
+ * @author Gabe Abrams
+ * @param operatorFunction the operator function to apply. If it returns true
+ *   for any item, this function will return true
+ * @returns true if the operator function returns true for any item in the array
+ */
+declare const someAsync: <T>(array: T[], operatorFunction: (item: T, index: number, opts: {
+    breakNow: () => void;
+    array: T[];
+}) => Promise<any>) => Promise<boolean>;
+export default someAsync;

package/dist/esm/types/helpers/asyncArrayFunctions/someAsync.test.d.ts

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

package/dist/esm/types/index.d.ts

@@ -70,6 +70,11 @@ import makeLinksClickable from './helpers/makeLinksClickable';
 import combineClassNames from './helpers/combineClassNames';
 import prefixWithAOrAn from './helpers/prefixWithAOrAn';
 import useForceRender from './helpers/useForceRender';
+import everyAsync from './helpers/asyncArrayFunctions/everyAsync';
+import filterAsync from './helpers/asyncArrayFunctions/filterAsync';
+import forEachAsync from './helpers/asyncArrayFunctions/forEachAsync';
+import mapAsync from './helpers/asyncArrayFunctions/mapAsync';
+import someAsync from './helpers/asyncArrayFunctions/someAsync';
 import ModalButtonType from './types/ModalButtonType';
 import ModalSize from './types/ModalSize';
 import ModalType from './types/ModalType';
@@ -89,4 +94,4 @@ import PickableItem from './components/ItemPicker/types/PickableItem';
 import DBEntry from './components/DBEntryManagerPanel/types/DBEntry';
 import DBEntryField from './components/DBEntryManagerPanel/types/DBEntryField';
 import DBEntryFieldType from './components/DBEntryManagerPanel/types/DBEntryFieldType';
-export { AppWrapper, LoadingSpinner, ErrorBox, Modal, TabBox, RadioButton, CheckboxButton, ButtonInputGroup, SimpleDateChooser, Drawer, PopSuccessMark, PopFailureMark, PopPendingMark, CopiableBox, ItemPicker, LogReviewer, IntelliTable, CSVDownloadButton, DBEntryManagerPanel, Tooltip, ToggleSwitch, AutoscrollToBottomContainer, MultiSwitch, alert, confirm, showFatalError, ErrorWithCode, MINUTE_IN_MS, HOUR_IN_MS, DAY_IN_MS, DynamicWord, abbreviate, avg, ceilToNumDecimals, floorToNumDecimals, forceNumIntoBounds, padDecimalZeros, padZerosLeft, roundToNumDecimals, sum, waitMs, getOrdinal, getTimeInfoInET, stubServerEndpoint, startMinWait, getHumanReadableDate, getPartOfDay, stringsToHumanReadableList, onlyKeepLetters, parallelLimit, getMonthName, genCSV, canReviewLogs, isMobileOrTablet, extractProp, compareArraysByProp, genCommaList, validateEmail, validatePhoneNumber, validateString, getLocalTimeInfo, idify, makeLinksClickable, prefixWithAOrAn, initClient, visitServerEndpoint, logClientEvent, addFatalErrorHandler, leaveToURL, combineClassNames, useForceRender, setClientEventMetadataPopulator, initServer, genRouteHandler, handleError, handleSuccess, initLogCollection, addDBEditorEndpoints, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInMetadata, LogMetadataType, LogFunction, IntelliTableColumn, PickableItem, DBEntry, DBEntryField, DBEntryFieldType, ParamType, };
+export { AppWrapper, LoadingSpinner, ErrorBox, Modal, TabBox, RadioButton, CheckboxButton, ButtonInputGroup, SimpleDateChooser, Drawer, PopSuccessMark, PopFailureMark, PopPendingMark, CopiableBox, ItemPicker, LogReviewer, IntelliTable, CSVDownloadButton, DBEntryManagerPanel, Tooltip, ToggleSwitch, AutoscrollToBottomContainer, MultiSwitch, alert, confirm, showFatalError, ErrorWithCode, MINUTE_IN_MS, HOUR_IN_MS, DAY_IN_MS, DynamicWord, abbreviate, avg, ceilToNumDecimals, floorToNumDecimals, forceNumIntoBounds, padDecimalZeros, padZerosLeft, roundToNumDecimals, sum, waitMs, getOrdinal, getTimeInfoInET, stubServerEndpoint, startMinWait, getHumanReadableDate, getPartOfDay, stringsToHumanReadableList, onlyKeepLetters, parallelLimit, getMonthName, genCSV, canReviewLogs, isMobileOrTablet, extractProp, compareArraysByProp, genCommaList, validateEmail, validatePhoneNumber, validateString, getLocalTimeInfo, idify, makeLinksClickable, prefixWithAOrAn, everyAsync, filterAsync, forEachAsync, mapAsync, someAsync, initClient, visitServerEndpoint, logClientEvent, addFatalErrorHandler, leaveToURL, combineClassNames, useForceRender, setClientEventMetadataPopulator, initServer, genRouteHandler, handleError, handleSuccess, initLogCollection, addDBEditorEndpoints, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInMetadata, LogMetadataType, LogFunction, IntelliTableColumn, PickableItem, DBEntry, DBEntryField, DBEntryFieldType, ParamType, };

package/dist/index.d.ts

@@ -153,6 +153,7 @@ type Props$j = {
     children?: React.ReactNode;
     onClose?: (type: ModalButtonType) => void;
     dontAllowBackdropExit?: boolean;
+    dontShowXButton?: boolean;
     okayLabel?: string;
     okayVariant?: Variant;
     cancelLabel?: string;
@@ -1465,6 +1466,66 @@ declare const prefixWithAOrAn: (text: string, capitalize?: boolean) => string;
  */
 declare const useForceRender: (useReducer: any) => () => void;
 
+/**
+ * Run the operator function on each item in the array, returning true if
+ *   the operator function returns true for every item in the array
+ * @author Gabe Abrams
+ * @param operatorFunction the operator function to apply. If it returns true
+ *   for every item, this function will return true
+ * @returns true if the operator function returns true for every item in the array
+ */
+declare const everyAsync: <T>(array: T[], operatorFunction: (item: T, index: number, opts: {
+    breakNow: () => void;
+    array: T[];
+}) => Promise<any>) => Promise<boolean>;
+
+/**
+ * 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: T[];
+}) => Promise<any>) => Promise<T[]>;
+
+/**
+ * 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: T[];
+}) => void) => Promise<void>;
+
+/**
+ * Run the operator function on each item in the array, collecting all results
+ * @author Gabe Abrams
+ * @param operatorFunction the operator function to apply
+ * @returns the array of results
+ */
+declare const mapAsync: <T, U>(array: T[], operatorFunction: (item: T, index: number, opts: {
+    breakNow: () => void;
+    array: T[];
+}) => Promise<U>) => Promise<U[]>;
+
+/**
+ * Run the operator function on each item in the array, returning true if
+ *   the operator function returns true for any item in the array
+ * @author Gabe Abrams
+ * @param operatorFunction the operator function to apply. If it returns true
+ *   for any item, this function will return true
+ * @returns true if the operator function returns true for any item in the array
+ */
+declare const someAsync: <T>(array: T[], operatorFunction: (item: T, index: number, opts: {
+    breakNow: () => void;
+    array: T[];
+}) => Promise<any>) => Promise<boolean>;
+
 /**
  * List of error codes built into the react kit
  * @author Gabe Abrams
@@ -1515,4 +1576,4 @@ declare const LogBuiltInMetadata: {
     };
 };
 
-export { AppWrapper, AutoscrollToBottomContainer, ButtonInputGroup, CSVDownloadButton, CheckboxButton, CopiableBox, DAY_IN_MS, DBEntry, DBEntryField, DBEntryFieldType, DBEntryManagerPanel, DayOfWeek, Drawer, DynamicWord, ErrorBox, ErrorWithCode, HOUR_IN_MS, IntelliTable, IntelliTableColumn, ItemPicker, LoadingSpinner, Log, LogAction, LogBuiltInMetadata, LogFunction, LogMetadataType, LogReviewer, LogSource, LogType, MINUTE_IN_MS, Modal, ModalButtonType, ModalSize, ModalType, MultiSwitch, ParamType, PickableItem, PopFailureMark, PopPendingMark, PopSuccessMark, RadioButton, ReactKitErrorCode, SimpleDateChooser, TabBox, ToggleSwitch, Tooltip, Variant, abbreviate, addDBEditorEndpoints, addFatalErrorHandler, alert, avg, canReviewLogs, ceilToNumDecimals, combineClassNames, compareArraysByProp, confirm, extractProp, floorToNumDecimals, forceNumIntoBounds, genCSV, genCommaList, genRouteHandler, getHumanReadableDate, getLocalTimeInfo, getMonthName, getOrdinal, getPartOfDay, getTimeInfoInET, handleError, handleSuccess, idify, initClient, initLogCollection, initServer, isMobileOrTablet, leaveToURL, logClientEvent, makeLinksClickable, onlyKeepLetters, padDecimalZeros, padZerosLeft, parallelLimit, prefixWithAOrAn, roundToNumDecimals, setClientEventMetadataPopulator, showFatalError, startMinWait, stringsToHumanReadableList, stubServerEndpoint, sum, useForceRender, validateEmail, validatePhoneNumber, validateString, visitServerEndpoint, waitMs };
+export { AppWrapper, AutoscrollToBottomContainer, ButtonInputGroup, CSVDownloadButton, CheckboxButton, CopiableBox, DAY_IN_MS, DBEntry, DBEntryField, DBEntryFieldType, DBEntryManagerPanel, DayOfWeek, Drawer, DynamicWord, ErrorBox, ErrorWithCode, HOUR_IN_MS, IntelliTable, IntelliTableColumn, ItemPicker, LoadingSpinner, Log, LogAction, LogBuiltInMetadata, LogFunction, LogMetadataType, LogReviewer, LogSource, LogType, MINUTE_IN_MS, Modal, ModalButtonType, ModalSize, ModalType, MultiSwitch, ParamType, PickableItem, PopFailureMark, PopPendingMark, PopSuccessMark, RadioButton, ReactKitErrorCode, SimpleDateChooser, TabBox, ToggleSwitch, Tooltip, Variant, abbreviate, addDBEditorEndpoints, addFatalErrorHandler, alert, avg, canReviewLogs, ceilToNumDecimals, combineClassNames, compareArraysByProp, confirm, everyAsync, extractProp, filterAsync, floorToNumDecimals, forEachAsync, forceNumIntoBounds, genCSV, genCommaList, genRouteHandler, getHumanReadableDate, getLocalTimeInfo, getMonthName, getOrdinal, getPartOfDay, getTimeInfoInET, handleError, handleSuccess, idify, initClient, initLogCollection, initServer, isMobileOrTablet, leaveToURL, logClientEvent, makeLinksClickable, mapAsync, onlyKeepLetters, padDecimalZeros, padZerosLeft, parallelLimit, prefixWithAOrAn, roundToNumDecimals, setClientEventMetadataPopulator, showFatalError, someAsync, startMinWait, stringsToHumanReadableList, stubServerEndpoint, sum, useForceRender, validateEmail, validatePhoneNumber, validateString, visitServerEndpoint, waitMs };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dce-reactkit",
-  "version": "3.7.3",
+  "version": "3.7.5",
   "description": "Shared components for Harvard DCE apps",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/src/components/CopiableBox.tsx

@@ -178,7 +178,7 @@ const CopiableBox: React.FC<Props> = (props) => {
   /*----------------------------------------*/
 
   return (
-    <div className="input-group mb-2">
+    <div className="input-group">
       {/* Label */}
       {(label || labelIcon) && (
         <span

package/src/components/Modal.tsx

@@ -222,6 +222,8 @@ type Props = {
   onClose?: (type: ModalButtonType) => void,
   // If true, don't allow the user to click the backdrop to exit
   dontAllowBackdropExit?: boolean,
+  // If true, don't show the "X" close button
+  dontShowXButton?: boolean,
   // Custom label for "okay" button
   okayLabel?: string,
   // Custom variant for "okay" button
@@ -284,6 +286,7 @@ const Modal: React.FC<Props> = (props) => {
     children,
     onClose,
     dontAllowBackdropExit,
+    dontShowXButton,
     onTopOfOtherModals,
   } = props;
 
@@ -496,7 +499,7 @@ const Modal: React.FC<Props> = (props) => {
               {title}
             </h5>
 
-            {onClose && (
+            {(onClose && !dontShowXButton) && (
               <button
                 type="button"
                 className="Modal-x-button btn-close"

package/src/components/Shimmer.tsx

@@ -0,0 +1,153 @@
+/**
+ * A shimmer effect to add to the background of an element. The parent of this element
+ *   will automatically have its overflow hidden
+ * @author Alessandra De Lucas
+ * @author Gabe Abrams
+ */
+
+// Import React
+import React, { useRef, useEffect } from 'react';
+
+// Import helpers
+import waitMs from '../helpers/waitMs';
+
+/*------------------------------------------------------------------------*/
+/* -------------------------------- Types ------------------------------- */
+/*------------------------------------------------------------------------*/
+
+// Props definition
+type Props = {
+  // The duration in seconds of the shimmer animation
+  durationSec?: number,
+  // The number of iterations of the shimmer animation
+  numShimmers?: number,
+};
+
+/*------------------------------------------------------------------------*/
+/* ------------------------------ Component ----------------------------- */
+/*------------------------------------------------------------------------*/
+
+const Shimmer: React.FC<Props> = (props) => {
+  /*------------------------------------------------------------------------*/
+  /* -------------------------------- Setup ------------------------------- */
+  /*------------------------------------------------------------------------*/
+
+  /* -------------- Props ------------- */
+
+  // Destructure all props
+  const {
+    durationSec = 2,
+    numShimmers,
+  } = props;
+
+  const numShimmerIterations: string = (
+    numShimmers
+      ? String(numShimmers)
+      : 'infinite'
+  );
+
+  /* --------------- Refs ------------- */
+
+  // Ref for the shimmer container
+  const containerRef = useRef<HTMLDivElement>(null);
+
+  /*------------------------------------------------------------------------*/
+  /* -------------------------------- Style ------------------------------- */
+  /*------------------------------------------------------------------------*/
+
+  // Style
+  const style = `
+    .Shimmer-container {
+      display: inline-block;
+      position: absolute;
+      left: 0;
+      top: 0;
+      width: 100%;
+      height: 0;
+      overflow: visible;
+    }
+
+    .Shimmer-shine {
+      display: inline-block;
+      position: absolute;
+      width: 100%;
+      height: 100vh;
+
+      background: linear-gradient(to right, rgba(255, 255, 255, 0), rgba(255, 255, 255, 0.5), rgba(255, 255, 255, 0)); 
+
+      animation-name: Shimmer-slide-animation;
+      animation-duration: ${durationSec}s;
+      animation-iteration-count: ${numShimmerIterations};
+      animation-timing-function: ease-in-out;
+      animation-fill-mode: both;
+    }
+
+    @keyframes Shimmer-slide-animation {
+      0% {
+        transform: translateX(-100%);
+      }
+      100% {
+        transform: translateX(100%);
+      }
+    }
+  `;
+
+  /*------------------------------------------------------------------------*/
+  /* ------------------------- Lifecycle Functions ------------------------ */
+  /*------------------------------------------------------------------------*/
+
+  /**
+   * Mount: force parent to have its overflow hidden
+   * @author Gabe Abrams
+   */
+  useEffect(
+    () => {
+      (async () => {
+        // Wait for the container to exist
+        while (!containerRef.current) {
+          await waitMs(20);
+        }
+
+        // Find the parent
+        const parent = containerRef.current.parentElement;
+        if (!parent) {
+          return;
+        }
+
+        // Force the parent's overflow to be hidden
+        parent.style.overflow = 'hidden';
+      })();
+    },
+    [],
+  );
+
+  /*------------------------------------------------------------------------*/
+  /* ------------------------------- Render ------------------------------- */
+  /*------------------------------------------------------------------------*/
+
+  /*----------------------------------------*/
+  /* --------------- Main UI -------------- */
+  /*----------------------------------------*/
+
+  return (
+    <div
+      className="Shimmer-container"
+      ref={containerRef}
+    >
+      {/* Style */}
+      <style>
+        {style}
+      </style>
+
+      {/* Moving shimmer */}
+      <div className="Shimmer-shine" />
+    </div>
+  );
+};
+
+/*------------------------------------------------------------------------*/
+/* ------------------------------- Wrap Up ------------------------------ */
+/*------------------------------------------------------------------------*/
+
+// Export component
+export default Shimmer;

package/src/helpers/asyncArrayFunctions/everyAsync.test.ts

@@ -0,0 +1,114 @@
+// Import item to test
+import everyAsync from './everyAsync';
+
+describe('everyAsync', () => {
+  it('returns true for an empty array', async () => {
+    const result = await everyAsync(
+      [],
+      async () => {
+        return true;
+      },
+    );
+    expect(result).toBe(true);
+  });
+
+  it('returns true if the operator function returns true for every item in the array', async () => {
+    const result = await everyAsync(
+      [1, 2, 3],
+      async (item) => {
+        return item > 0;
+      },
+    );
+    expect(result).toBe(true);
+  });
+
+  it('returns false if the operator function returns false for any item in the array', async () => {
+    const result = await everyAsync(
+      [1, 2, 3],
+      async (item) => {
+        return item > 1;
+      },
+    );
+    expect(result).toBe(false);
+  });
+
+  it('passes the index as the second argument to the operator function', async () => {
+    const result = await everyAsync(
+      [1, 2, 3],
+      async (item, index) => {
+        return index === item - 1;
+      },
+    );
+    expect(result).toBe(true);
+  });
+
+  it('passes an object with a breakNow function and the array as the third argument to the operator function', async () => {
+    const result = await everyAsync(
+      [1, 2, 3],
+      async (item, index, { breakNow }) => {
+        if (item === 2) {
+          breakNow();
+        }
+        return true;
+      },
+    );
+    expect(result).toBe(false);
+  });
+
+  it('stops iterating if the operator function calls the breakNow function', async () => {
+    const mockOperatorFunction = jest.fn(async (item, index, { breakNow }) => {
+      if (item === 2) {
+        breakNow();
+      }
+      return true;
+    });
+    const result = await everyAsync(
+      [1, 2, 3],
+      mockOperatorFunction,
+    );
+    expect(result).toBe(false);
+    expect(mockOperatorFunction).toHaveBeenCalledTimes(2);
+  });
+
+  it('handles an operator function that returns a promise that resolves to true', async () => {
+    const result = await everyAsync(
+      [1, 2, 3],
+      async (item) => {
+        return Promise.resolve(item > 0);
+      },
+    );
+    expect(result).toBe(true);
+  });
+
+  it('handles an operator function that returns a promise that resolves to false', async () => {
+    const result = await everyAsync(
+      [1, 2, 3],
+      async (item) => {
+        return Promise.resolve(item > 1);
+      },
+    );
+    expect(result).toBe(false);
+  });
+
+  it('handles an operator function that throws an error', async () => {
+    const mockOperatorFunction = jest.fn(async (item) => {
+      if (item === 2) {
+        throw new Error('Test error');
+      }
+      return true;
+    });
+    let error: any = null;
+    let result: boolean | null = null;
+    try {
+      result = await everyAsync(
+        [1, 2, 3],
+        mockOperatorFunction,
+      );
+    } catch (err) {
+      error = err;
+    }
+    expect(result).toBe(null);
+    expect(error).not.toBe(null);
+    expect(mockOperatorFunction).toHaveBeenCalledTimes(2);
+  });
+});

package/src/helpers/asyncArrayFunctions/everyAsync.ts

@@ -0,0 +1,51 @@
+/**
+ * Run the operator function on each item in the array, returning true if
+ *   the operator function returns true for every item in the array
+ * @author Gabe Abrams
+ * @param operatorFunction the operator function to apply. If it returns true
+ *   for every item, this function will return true
+ * @returns true if the operator function returns true for every item in the array
+ */
+const everyAsync = async <T>(
+  array: T[],
+  operatorFunction: (
+    item: T,
+    index: number,
+    opts: {
+      breakNow: () => void,
+      array: Array<T>,
+    },
+  ) => Promise<any>,
+): Promise<boolean> => {
+  // Create break logic
+  let done = false;
+  /**
+   * Break the loop (checking stops here)
+   * @author Gabe Abrams
+   */
+  const breakNow = () => {
+    done = true;
+  };
+
+  // Loop through each item, checking
+  for (let i = 0; i < array.length && !done; i++) {
+    const passed = await operatorFunction(
+      array[i],
+      i,
+      {
+        breakNow,
+        array,
+      },
+    );
+
+    // Check if this one failed or if loop was broken
+    if (!passed || done) {
+      return false;
+    }
+  }
+
+  // Return true because none returned false
+  return true;
+};
+
+export default everyAsync;