@isograph/reference-counted-pointer 0.0.0-main-55364d41 → 0.0.0-main-2c275831

package/dist/createReferenceCountedPointer.d.ts

@@ -1,4 +1,4 @@
-import type { ItemCleanupPair } from "@isograph/disposable-types";
+import type { ItemCleanupPair } from '@isograph/disposable-types';
 /**
  * Create an undisposed reference-counted pointer guarding a given item.
  *

package/dist/createReferenceCountedPointer.js

@@ -57,17 +57,17 @@ class RefCounter {
             let disposed = false;
             const dispose = () => {
                 if (disposed) {
-                    throw new Error("Do not dispose an already-disposed ActiveReference.");
+                    throw new Error('Do not dispose an already-disposed ActiveReference.');
                 }
                 disposed = true;
                 if (activeReference.__original === null) {
-                    throw new Error("Attempted to dispose an active reference, but it was already disposed. " +
-                        "This indicates a bug in reference-counted-pointer.");
+                    throw new Error('Attempted to dispose an active reference, but it was already disposed. ' +
+                        'This indicates a bug in reference-counted-pointer.');
                 }
                 activeReference.__original = null;
                 if (this.__state === null) {
-                    throw new Error("Attempted to dispose, but the underlying reference counted pointer was disposed. " +
-                        "This indicates a bug in reference-counted-pointer.");
+                    throw new Error('Attempted to dispose, but the underlying reference counted pointer was disposed. ' +
+                        'This indicates a bug in reference-counted-pointer.');
                 }
                 this.__state.activeReferenceCount--;
                 this.__maybeDispose();
@@ -80,8 +80,8 @@ class RefCounter {
     }
     __maybeDispose() {
         if (this.__state === null) {
-            throw new Error("__maybeDispose was called, but the reference counted pointer was disposed. " +
-                "This indicates a bug in reference-counted-pointer.");
+            throw new Error('__maybeDispose was called, but the reference counted pointer was disposed. ' +
+                'This indicates a bug in reference-counted-pointer.');
         }
         if (this.__state.activeReferenceCount === 0) {
             this.__state.dispose();

package/dist/index.d.ts

@@ -1 +1 @@
-export * from "./createReferenceCountedPointer";
+export * from './createReferenceCountedPointer';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@isograph/reference-counted-pointer",
-  "version": "0.0.0-main-55364d41",
+  "version": "0.0.0-main-2c275831",
   "description": "Reference counted pointers enable sharing of disposable items.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -14,7 +14,7 @@
     "coverage": "vitest run --coverage"
   },
   "dependencies": {
-    "@isograph/disposable-types": "0.0.0-main-55364d41",
+    "@isograph/disposable-types": "0.0.0-main-2c275831",
     "react": "^18.2.0"
   },
   "devDependencies": {

package/src/createReferenceCountedPointer.test.ts

@@ -1,25 +1,19 @@
-import { describe, test, vi, expect, assert } from "vitest";
-import { createReferenceCountedPointer } from "./createReferenceCountedPointer";
+import { describe, test, vi, expect, assert } from 'vitest';
+import { createReferenceCountedPointer } from './createReferenceCountedPointer';
 
-describe("createReferenceCountedPointer", () => {
-  describe("it should not dispose the underlying item until all outstanding pointers are disposed", () => {
-    test("one pointer", () => {
+describe('createReferenceCountedPointer', () => {
+  describe('it should not dispose the underlying item until all outstanding pointers are disposed', () => {
+    test('one pointer', () => {
       const disposeItem = vi.fn();
-      const [pointer, disposePointer] = createReferenceCountedPointer([
-        1,
-        disposeItem,
-      ]);
+      const [pointer, disposePointer] = createReferenceCountedPointer([1, disposeItem]);
       expect(disposeItem).not.toHaveBeenCalled();
       disposePointer();
       expect(disposeItem).toHaveBeenCalled();
     });
 
-    test("linked list, FIFO", () => {
+    test('linked list, FIFO', () => {
       const disposeItem = vi.fn();
-      const [pointer, disposePointer] = createReferenceCountedPointer([
-        1,
-        disposeItem,
-      ]);
+      const [pointer, disposePointer] = createReferenceCountedPointer([1, disposeItem]);
       const [pointer2, disposePointer2] = pointer.cloneIfNotDisposed()!;
       const [pointer3, disposePointer3] = pointer2.cloneIfNotDisposed()!;
       const [pointer4, disposePointer4] = pointer3.cloneIfNotDisposed()!;
@@ -32,12 +26,9 @@ describe("createReferenceCountedPointer", () => {
       expect(disposeItem).toHaveBeenCalled();
     });
 
-    test("linked list, LIFO", () => {
+    test('linked list, LIFO', () => {
       const disposeItem = vi.fn();
-      const [pointer, disposePointer] = createReferenceCountedPointer([
-        1,
-        disposeItem,
-      ]);
+      const [pointer, disposePointer] = createReferenceCountedPointer([1, disposeItem]);
       const [pointer2, disposePointer2] = pointer.cloneIfNotDisposed()!;
       const [pointer3, disposePointer3] = pointer2.cloneIfNotDisposed()!;
       const [pointer4, disposePointer4] = pointer3.cloneIfNotDisposed()!;
@@ -50,12 +41,9 @@ describe("createReferenceCountedPointer", () => {
       expect(disposeItem).toHaveBeenCalled();
     });
 
-    test("linked list, mixed order", () => {
+    test('linked list, mixed order', () => {
       const disposeItem = vi.fn();
-      const [pointer, disposePointer] = createReferenceCountedPointer([
-        1,
-        disposeItem,
-      ]);
+      const [pointer, disposePointer] = createReferenceCountedPointer([1, disposeItem]);
       const [pointer2, disposePointer2] = pointer.cloneIfNotDisposed()!;
       const [pointer3, disposePointer3] = pointer2.cloneIfNotDisposed()!;
       const [pointer4, disposePointer4] = pointer3.cloneIfNotDisposed()!;
@@ -68,12 +56,9 @@ describe("createReferenceCountedPointer", () => {
       expect(disposeItem).toHaveBeenCalled();
     });
 
-    test("DAG, from root", () => {
+    test('DAG, from root', () => {
       const disposeItem = vi.fn();
-      const [pointer, disposePointer] = createReferenceCountedPointer([
-        1,
-        disposeItem,
-      ]);
+      const [pointer, disposePointer] = createReferenceCountedPointer([1, disposeItem]);
       const [pointerA, disposePointerA] = pointer.cloneIfNotDisposed()!;
       const [pointerA_1, disposePointerA_1] = pointerA.cloneIfNotDisposed()!;
       const [pointerA_2, disposePointerA_2] = pointerA.cloneIfNotDisposed()!;
@@ -92,12 +77,9 @@ describe("createReferenceCountedPointer", () => {
       expect(disposeItem).toHaveBeenCalled();
     });
 
-    test("DAG, from leaves", () => {
+    test('DAG, from leaves', () => {
       const disposeItem = vi.fn();
-      const [pointer, disposePointer] = createReferenceCountedPointer([
-        1,
-        disposeItem,
-      ]);
+      const [pointer, disposePointer] = createReferenceCountedPointer([1, disposeItem]);
       const [pointerA, disposePointerA] = pointer.cloneIfNotDisposed()!;
       const [pointerA_1, disposePointerA_1] = pointerA.cloneIfNotDisposed()!;
       const [pointerA_2, disposePointerA_2] = pointerA.cloneIfNotDisposed()!;
@@ -116,12 +98,9 @@ describe("createReferenceCountedPointer", () => {
       expect(disposeItem).toHaveBeenCalled();
     });
 
-    test("DAG, random", () => {
+    test('DAG, random', () => {
       const disposeItem = vi.fn();
-      const [pointer, disposePointer] = createReferenceCountedPointer([
-        1,
-        disposeItem,
-      ]);
+      const [pointer, disposePointer] = createReferenceCountedPointer([1, disposeItem]);
       const [pointerA, disposePointerA] = pointer.cloneIfNotDisposed()!;
       const [pointerA_1, disposePointerA_1] = pointerA.cloneIfNotDisposed()!;
       const [pointerA_2, disposePointerA_2] = pointerA.cloneIfNotDisposed()!;
@@ -141,56 +120,41 @@ describe("createReferenceCountedPointer", () => {
     });
   });
 
-  test("it should throw when disposed twice", () => {
+  test('it should throw when disposed twice', () => {
     const disposeItem = vi.fn();
-    const [pointer, disposePointer] = createReferenceCountedPointer([
-      1,
-      disposeItem,
-    ]);
+    const [pointer, disposePointer] = createReferenceCountedPointer([1, disposeItem]);
     disposePointer();
     expect(() => {
       disposePointer();
     }).toThrow();
   });
 
-  test("it should return null when you attempt to retain a disposed pointer", () => {
+  test('it should return null when you attempt to retain a disposed pointer', () => {
     const disposeItem = vi.fn();
-    const [pointer, disposePointer] = createReferenceCountedPointer([
-      1,
-      disposeItem,
-    ]);
+    const [pointer, disposePointer] = createReferenceCountedPointer([1, disposeItem]);
     disposePointer();
     expect(pointer.cloneIfNotDisposed()).toBe(null);
   });
 
-  test("it should expose the underlying object only when undisposed", () => {
+  test('it should expose the underlying object only when undisposed', () => {
     const disposeItem = vi.fn();
-    const [pointer, disposePointer] = createReferenceCountedPointer([
-      1,
-      disposeItem,
-    ]);
+    const [pointer, disposePointer] = createReferenceCountedPointer([1, disposeItem]);
     expect(pointer.getItemIfNotDisposed()).toBe(1);
     disposePointer();
     expect(pointer.getItemIfNotDisposed()).toBe(null);
   });
 
-  test("it should accurately report its disposed status", () => {
+  test('it should accurately report its disposed status', () => {
     const disposeItem = vi.fn();
-    const [pointer, disposePointer] = createReferenceCountedPointer([
-      1,
-      disposeItem,
-    ]);
+    const [pointer, disposePointer] = createReferenceCountedPointer([1, disposeItem]);
     expect(pointer.isDisposed()).toBe(false);
     disposePointer();
     expect(pointer.isDisposed()).toBe(true);
   });
 
-  test("disposable status is unaffected by the presence of other undisposed pointers", () => {
+  test('disposable status is unaffected by the presence of other undisposed pointers', () => {
     const disposeItem = vi.fn();
-    const [pointer, disposePointer] = createReferenceCountedPointer([
-      1,
-      disposeItem,
-    ]);
+    const [pointer, disposePointer] = createReferenceCountedPointer([1, disposeItem]);
     const pointer2 = pointer.cloneIfNotDisposed();
     assert(pointer2 != null);
     expect(pointer2[0].isDisposed()).toBe(false);

package/src/createReferenceCountedPointer.ts

@@ -1,4 +1,4 @@
-import type { CleanupFn, ItemCleanupPair } from "@isograph/disposable-types";
+import type { CleanupFn, ItemCleanupPair } from '@isograph/disposable-types';
 
 // TODO cloneIfNotDisposed should also return the underlying item
 
@@ -25,7 +25,7 @@ import type { CleanupFn, ItemCleanupPair } from "@isograph/disposable-types";
  * was never disposed, and we could reuse it between states.
  */
 export function createReferenceCountedPointer<T>(
-  pair: ItemCleanupPair<T>
+  pair: ItemCleanupPair<T>,
 ): ItemCleanupPair<ReferenceCountedPointer<T>> {
   const originalReferenceCountedPointer = new RefCounter(pair);
 
@@ -83,22 +83,20 @@ class RefCounter<T> {
       let disposed = false;
       const dispose = () => {
         if (disposed) {
-          throw new Error(
-            "Do not dispose an already-disposed ActiveReference."
-          );
+          throw new Error('Do not dispose an already-disposed ActiveReference.');
         }
         disposed = true;
         if (activeReference.__original === null) {
           throw new Error(
-            "Attempted to dispose an active reference, but it was already disposed. " +
-              "This indicates a bug in reference-counted-pointer."
+            'Attempted to dispose an active reference, but it was already disposed. ' +
+              'This indicates a bug in reference-counted-pointer.',
           );
         }
         activeReference.__original = null;
         if (this.__state === null) {
           throw new Error(
-            "Attempted to dispose, but the underlying reference counted pointer was disposed. " +
-              "This indicates a bug in reference-counted-pointer."
+            'Attempted to dispose, but the underlying reference counted pointer was disposed. ' +
+              'This indicates a bug in reference-counted-pointer.',
           );
         }
         this.__state.activeReferenceCount--;
@@ -114,8 +112,8 @@ class RefCounter<T> {
   private __maybeDispose() {
     if (this.__state === null) {
       throw new Error(
-        "__maybeDispose was called, but the reference counted pointer was disposed. " +
-          "This indicates a bug in reference-counted-pointer."
+        '__maybeDispose was called, but the reference counted pointer was disposed. ' +
+          'This indicates a bug in reference-counted-pointer.',
       );
     }
     if (this.__state.activeReferenceCount === 0) {

package/src/index.ts

@@ -1 +1 @@
-export * from "./createReferenceCountedPointer";
+export * from './createReferenceCountedPointer';