@isograph/disposable-types 0.0.4

package/README.md

@@ -0,0 +1,33 @@
+# @isograph/disposable-types
+
+> A shared library that exports commonly-used types related to disposable items.
+
+See the `@isograph/react-disposable-state` library for more information.
+
+## What is a disposable item?
+
+A disposable item is anything that is either explicitly created or must be explicitly cleaned up. That is, it is an item with a lifecycle.
+
+A disposable item is safe to use as long as its destructor has not been called.
+
+Code that manages disposable items (such as the `useDisposableState` hook) should also ensure that each destructor is eventually called, and should not provide access to the underlying item once the destructor has been called.
+
+Disposable items are allowed to have side effects when created or when destroyed.
+
+### Example
+
+An example might be a claim to a resource in a shared store.
+
+```js
+const [claim, disposeClaim]: ItemCleanupPair<Claim> = store.getClaimToResource({
+  id: 4,
+});
+
+// Because the claim has not been disposed, this is safe to do:
+const data = store.lookup(claim);
+
+disposeClaim();
+
+// Now that we've disposed of the claim, the underlying resource might have been removed from the store, so the following is not safe:
+const unsafeData = store.lookup(claim);
+```

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export type CleanupFn = () => void;
+export type ItemCleanupPair<T> = [T, CleanupFn];
+export type Factory<T> = () => ItemCleanupPair<T>;

package/dist/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@isograph/disposable-types",
+  "version": "0.0.4",
+  "description": "Common types for disposable items",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "author": "Isograph Labs",
+  "license": "MIT",
+  "scripts": {
+    "compile": "rm -rf dist/* && tsc -p tsconfig.pkg.json",
+    "compile-watch": "tsc -p tsconfig.pkg.json --watch",
+    "test": "echo this package has no tests",
+    "test-watch": "echo this package has no tests",
+    "coverage": "echo this package has no coverage",
+    "prepack": "yarn run compile"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "typescript": "^5.0.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export type CleanupFn = () => void;
+export type ItemCleanupPair<T> = [T, CleanupFn];
+export type Factory<T> = () => ItemCleanupPair<T>;

package/tsconfig.pkg.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.build.json",
+  "compilerOptions": {
+    "outDir": "./dist/",
+    "rootDir": "./src/",
+    "declaration": true
+  },
+  "include": ["src/**/*.ts"]
+}