@e280/stz 0.0.0-36 → 0.0.0-38

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@e280/stz",
-	"version": "0.0.0-36",
+	"version": "0.0.0-38",
 	"description": "everyday ts fns for everything",
 	"license": "MIT",
 	"author": "Chase Moskal <chasemoskal@gmail.com>",

package/s/index.ts

@@ -35,6 +35,7 @@ export * from "./once.js"
 export * from "./pipe.js"
 export * from "./pubsub.js"
 export * from "./repeat.js"
+export * from "./scope.js"
 export * from "./templating.js"
 export * from "./time.js"
 export * from "./trash.js"

package/s/scope.ts

@@ -0,0 +1,111 @@
+
+export type Scoped<Item> = [item: Item, dispose: () => void]
+export abstract class Disposable { abstract dispose(): void }
+
+export type DisposableClass = {
+	new(...p: any[]): any
+	dispose(): void
+}
+
+export function scoped<Item>(item: Item, dispose: () => void) {
+	return [item, dispose] as Scoped<Item>
+}
+
+/**
+ * a trashcan you can fill with garbage, then call `scope.dispose()` to dump it all
+ *  - `add/stow/scoped` methods are for dealing with disposer fns
+ *  - `keep` methods are for dealing with disposable objects (with a dispose method)
+ *  - `sub` for creating nested sub-scopes
+ */
+export class Scope extends Disposable {
+	#disposers: (() => void)[] = []
+
+	/** add disposer fn */
+	add(dispose: () => void) {
+		this.#disposers.push(dispose)
+		return this
+	}
+
+	/** add disposer, return item */
+	stow<Item>(item: Item, dispose: () => void) {
+		this.add(dispose)
+		return item
+	}
+
+	/** add scoped disposer, return item */
+	scoped<Item>([item, dispose]: Scoped<Item>) {
+		this.add(dispose)
+		return item
+	}
+
+	/** add and return a disposable object */
+	keep<D extends Disposable>(disposable: D) {
+		this.add(() => disposable.dispose())
+		return disposable
+	}
+
+	/** wrap a fn, auto-add returned disposers */
+	scopedFn<Params extends any[], Item>(
+			fn: (...params: Params) => Scoped<Item>
+		) {
+		return (...a: Params) => {
+			const scoped = fn(...a)
+			return this.scoped(scoped)
+		}
+	}
+
+	/** wrap an async fn, auto-add returned disposers */
+	scopedFnAsync<Params extends any[], Item>(
+			fn: (...params: Params) => Promise<Scoped<Item>>
+		) {
+		return async(...a: Params) => {
+			const scoped = await fn(...a)
+			return this.scoped(scoped)
+		}
+	}
+
+	/** wrap a fn, auto-add returned disposables */
+	keepFn<Params extends any[], D extends Disposable>(
+			fn: (...params: Params) => D
+		) {
+		return (...a: Params) => {
+			const disposable = fn(...a)
+			return this.keep(disposable)
+		}
+	}
+
+	/** wrap an async fn, auto-add returned disposables */
+	keepFnAsync<Params extends any[], D extends Disposable>(
+			fn: (...params: Params) => Promise<D>
+		) {
+		return async(...a: Params) => {
+			const disposable = await fn(...a)
+			return this.keep(disposable)
+		}
+	}
+
+	/** wrap a constructor, auto-add returned disposables */
+	keepConstructor<C extends DisposableClass>(Ctor: C) {
+		const scope = this
+		return class extends Ctor {
+			constructor(...p: any[]) {
+				super(...p)
+				scope.keep(this as any)
+			}
+		}
+	}
+
+	/** create a subscope, child gets disposed when parent does */
+	sub() {
+		const subscope = new Scope()
+		return this.stow(subscope, () => subscope.dispose())
+	}
+
+	/** dispose everything in this scope, in reverse order */
+	dispose() {
+		for (const fn of this.#disposers.reverse())
+			fn()
+		this.#disposers = []
+	}
+}
+

package/x/index.d.ts

@@ -30,6 +30,7 @@ export * from "./once.js";
 export * from "./pipe.js";
 export * from "./pubsub.js";
 export * from "./repeat.js";
+export * from "./scope.js";
 export * from "./templating.js";
 export * from "./time.js";
 export * from "./trash.js";

package/x/index.js

@@ -30,6 +30,7 @@ export * from "./once.js";
 export * from "./pipe.js";
 export * from "./pubsub.js";
 export * from "./repeat.js";
+export * from "./scope.js";
 export * from "./templating.js";
 export * from "./time.js";
 export * from "./trash.js";

package/x/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../s/index.ts"],"names":[],"mappings":"AACA,cAAc,0BAA0B,CAAA;AACxC,cAAc,kBAAkB,CAAA;AAChC,cAAc,kBAAkB,CAAA;AAChC,cAAc,kBAAkB,CAAA;AAChC,cAAc,qBAAqB,CAAA;AACnC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,eAAe,CAAA;AAE7B,cAAc,wBAAwB,CAAA;AACtC,cAAc,qBAAqB,CAAA;AAEnC,cAAc,gBAAgB,CAAA;AAE9B,cAAc,kBAAkB,CAAA;AAEhC,cAAc,eAAe,CAAA;AAC7B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,kBAAkB,CAAA;AAChC,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,SAAS,CAAA;AACvB,cAAc,UAAU,CAAA;AACxB,cAAc,iBAAiB,CAAA;AAC/B,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA;AACvB,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AACzB,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,WAAW,CAAA;AACzB,cAAc,YAAY,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../s/index.ts"],"names":[],"mappings":"AACA,cAAc,0BAA0B,CAAA;AACxC,cAAc,kBAAkB,CAAA;AAChC,cAAc,kBAAkB,CAAA;AAChC,cAAc,kBAAkB,CAAA;AAChC,cAAc,qBAAqB,CAAA;AACnC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,eAAe,CAAA;AAE7B,cAAc,wBAAwB,CAAA;AACtC,cAAc,qBAAqB,CAAA;AAEnC,cAAc,gBAAgB,CAAA;AAE9B,cAAc,kBAAkB,CAAA;AAEhC,cAAc,eAAe,CAAA;AAC7B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,kBAAkB,CAAA;AAChC,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,mBAAmB,CAAA;AACjC,cAAc,SAAS,CAAA;AACvB,cAAc,UAAU,CAAA;AACxB,cAAc,iBAAiB,CAAA;AAC/B,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA;AACvB,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AACzB,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,WAAW,CAAA;AACzB,cAAc,YAAY,CAAA"}

package/x/scope.d.ts

@@ -0,0 +1,45 @@
+export type Scoped<Item> = [item: Item, dispose: () => void];
+export declare abstract class Disposable {
+    abstract dispose(): void;
+}
+export type DisposableClass = {
+    new (...p: any[]): any;
+    dispose(): void;
+};
+export declare function scoped<Item>(item: Item, dispose: () => void): Scoped<Item>;
+/**
+ * a trashcan you can fill with garbage, then call `scope.dispose()` to dump it all
+ *  - `add/stow/scoped` methods are for dealing with disposer fns
+ *  - `keep` methods are for dealing with disposable objects (with a dispose method)
+ *  - `sub` for creating nested sub-scopes
+ */
+export declare class Scope extends Disposable {
+    #private;
+    /** add disposer fn */
+    add(dispose: () => void): this;
+    /** add disposer, return item */
+    stow<Item>(item: Item, dispose: () => void): Item;
+    /** add scoped disposer, return item */
+    scoped<Item>([item, dispose]: Scoped<Item>): Item;
+    /** add and return a disposable object */
+    keep<D extends Disposable>(disposable: D): D;
+    /** wrap a fn, auto-add returned disposers */
+    scopedFn<Params extends any[], Item>(fn: (...params: Params) => Scoped<Item>): (...a: Params) => Item;
+    /** wrap an async fn, auto-add returned disposers */
+    scopedFnAsync<Params extends any[], Item>(fn: (...params: Params) => Promise<Scoped<Item>>): (...a: Params) => Promise<Item>;
+    /** wrap a fn, auto-add returned disposables */
+    keepFn<Params extends any[], D extends Disposable>(fn: (...params: Params) => D): (...a: Params) => D;
+    /** wrap an async fn, auto-add returned disposables */
+    keepFnAsync<Params extends any[], D extends Disposable>(fn: (...params: Params) => Promise<D>): (...a: Params) => Promise<D>;
+    /** wrap a constructor, auto-add returned disposables */
+    keepConstructor<C extends DisposableClass>(Ctor: C): {
+        new (...p: any[]): {
+            [x: string]: any;
+        };
+        dispose(): void;
+    } & C;
+    /** create a subscope, child gets disposed when parent does */
+    sub(): Scope;
+    /** dispose everything in this scope, in reverse order */
+    dispose(): void;
+}

package/x/scope.js

@@ -0,0 +1,84 @@
+export class Disposable {
+}
+export function scoped(item, dispose) {
+    return [item, dispose];
+}
+/**
+ * a trashcan you can fill with garbage, then call `scope.dispose()` to dump it all
+ *  - `add/stow/scoped` methods are for dealing with disposer fns
+ *  - `keep` methods are for dealing with disposable objects (with a dispose method)
+ *  - `sub` for creating nested sub-scopes
+ */
+export class Scope extends Disposable {
+    #disposers = [];
+    /** add disposer fn */
+    add(dispose) {
+        this.#disposers.push(dispose);
+        return this;
+    }
+    /** add disposer, return item */
+    stow(item, dispose) {
+        this.add(dispose);
+        return item;
+    }
+    /** add scoped disposer, return item */
+    scoped([item, dispose]) {
+        this.add(dispose);
+        return item;
+    }
+    /** add and return a disposable object */
+    keep(disposable) {
+        this.add(() => disposable.dispose());
+        return disposable;
+    }
+    /** wrap a fn, auto-add returned disposers */
+    scopedFn(fn) {
+        return (...a) => {
+            const scoped = fn(...a);
+            return this.scoped(scoped);
+        };
+    }
+    /** wrap an async fn, auto-add returned disposers */
+    scopedFnAsync(fn) {
+        return async (...a) => {
+            const scoped = await fn(...a);
+            return this.scoped(scoped);
+        };
+    }
+    /** wrap a fn, auto-add returned disposables */
+    keepFn(fn) {
+        return (...a) => {
+            const disposable = fn(...a);
+            return this.keep(disposable);
+        };
+    }
+    /** wrap an async fn, auto-add returned disposables */
+    keepFnAsync(fn) {
+        return async (...a) => {
+            const disposable = await fn(...a);
+            return this.keep(disposable);
+        };
+    }
+    /** wrap a constructor, auto-add returned disposables */
+    keepConstructor(Ctor) {
+        const scope = this;
+        return class extends Ctor {
+            constructor(...p) {
+                super(...p);
+                scope.keep(this);
+            }
+        };
+    }
+    /** create a subscope, child gets disposed when parent does */
+    sub() {
+        const subscope = new Scope();
+        return this.stow(subscope, () => subscope.dispose());
+    }
+    /** dispose everything in this scope, in reverse order */
+    dispose() {
+        for (const fn of this.#disposers.reverse())
+            fn();
+        this.#disposers = [];
+    }
+}
+//# sourceMappingURL=scope.js.map

package/x/scope.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scope.js","sourceRoot":"","sources":["../s/scope.ts"],"names":[],"mappings":"AAEA,MAAM,OAAgB,UAAU;CAA6B;AAO7D,MAAM,UAAU,MAAM,CAAO,IAAU,EAAE,OAAmB;IAC3D,OAAO,CAAC,IAAI,EAAE,OAAO,CAAiB,CAAA;AACvC,CAAC;AAED;;;;;GAKG;AACH,MAAM,OAAO,KAAM,SAAQ,UAAU;IACpC,UAAU,GAAmB,EAAE,CAAA;IAE/B,sBAAsB;IACtB,GAAG,CAAC,OAAmB;QACtB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAC7B,OAAO,IAAI,CAAA;IACZ,CAAC;IAED,gCAAgC;IAChC,IAAI,CAAO,IAAU,EAAE,OAAmB;QACzC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;QACjB,OAAO,IAAI,CAAA;IACZ,CAAC;IAED,uCAAuC;IACvC,MAAM,CAAO,CAAC,IAAI,EAAE,OAAO,CAAe;QACzC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;QACjB,OAAO,IAAI,CAAA;IACZ,CAAC;IAED,yCAAyC;IACzC,IAAI,CAAuB,UAAa;QACvC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAA;QACpC,OAAO,UAAU,CAAA;IAClB,CAAC;IAED,6CAA6C;IAC7C,QAAQ,CACN,EAAuC;QAExC,OAAO,CAAC,GAAG,CAAS,EAAE,EAAE;YACvB,MAAM,MAAM,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAA;YACvB,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAC3B,CAAC,CAAA;IACF,CAAC;IAED,oDAAoD;IACpD,aAAa,CACX,EAAgD;QAEjD,OAAO,KAAK,EAAC,GAAG,CAAS,EAAE,EAAE;YAC5B,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAA;YAC7B,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAC3B,CAAC,CAAA;IACF,CAAC;IAED,+CAA+C;IAC/C,MAAM,CACJ,EAA4B;QAE7B,OAAO,CAAC,GAAG,CAAS,EAAE,EAAE;YACvB,MAAM,UAAU,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAA;YAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAC7B,CAAC,CAAA;IACF,CAAC;IAED,sDAAsD;IACtD,WAAW,CACT,EAAqC;QAEtC,OAAO,KAAK,EAAC,GAAG,CAAS,EAAE,EAAE;YAC5B,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAA;YACjC,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAC7B,CAAC,CAAA;IACF,CAAC;IAED,wDAAwD;IACxD,eAAe,CAA4B,IAAO;QACjD,MAAM,KAAK,GAAG,IAAI,CAAA;QAClB,OAAO,KAAM,SAAQ,IAAI;YACxB,YAAY,GAAG,CAAQ;gBACtB,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;gBACX,KAAK,CAAC,IAAI,CAAC,IAAW,CAAC,CAAA;YACxB,CAAC;SACD,CAAA;IACF,CAAC;IAED,8DAA8D;IAC9D,GAAG;QACF,MAAM,QAAQ,GAAG,IAAI,KAAK,EAAE,CAAA;QAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAA;IACrD,CAAC;IAED,yDAAyD;IACzD,OAAO;QACN,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE;YACzC,EAAE,EAAE,CAAA;QACL,IAAI,CAAC,UAAU,GAAG,EAAE,CAAA;IACrB,CAAC;CACD"}