Function createCleanupObject

core/utils/cleanup.ts:23–62

()

 * })
 */
export function createCleanupObject() {
  const cleanups = new Set<Cleanup>();

  const cleanupObject = {
    clean() {
      /**
       * We start cleaning up from last items added. It is the same as eg, react effect where children effects are cleaned up before parents.
       *
       * Rationale is that cleanups added last might depend on something created before and if we clean them first, they might not be able to clean up properly.
       */
      const cleanupsList = [...cleanups].reverse();
      cleanups.clear();

      runInAction(() => {
        cleanupsList.forEach((cleanup) => {
          cleanup();
        });
      });
    },
    cleanOne(cleanup: Cleanup) {
      if (!cleanups.has(cleanup)) return false;

      cleanups.delete(cleanup);

      cleanup();

      return true;
    },
    set next(cleanupToAdd: MaybeCleanup | void) {
      if (!cleanupToAdd) return;

      cleanups.add(cleanupToAdd);
    },
    get size() {
      return cleanups.size;
    },
  };

  return cleanupObject;
}