Skip to content

feat: implement Symbol.dispose and Symbol.asyncDisposable for ManagedRuntime #5482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: next-minor
Choose a base branch
from
+20 −0
Open

feat: implement Symbol.dispose and Symbol.asyncDisposable for ManagedRuntime #5482

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9838b24
implement `Symbol.dispose` and `Symbol.asyncDisposable` for ManagedRu…
patroza Sep 9, 2025
a2d5a3a
use runFork so that we support async cleanup if needed too even on th…
patroza Sep 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/beige-socks-admire.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"effect": minor
---

implement `Symbol.dispose` and `Symbol.asyncDisposable` for ManagedRuntime
9 changes: 9 additions & 0 deletions packages/effect/src/ManagedRuntime.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,15 @@ export interface ManagedRuntime<in R, out ER> extends Effect.Effect<Runtime.Runt
*/
readonly disposeEffect: Effect.Effect<void, never, never>

/**
* Dispose of the resources associated with the runtime.
*/
[Symbol.dispose](): void
/**
* Dispose of the resources associated with the runtime.
*/
[Symbol.asyncDispose](): Promise<void>

readonly [Unify.typeSymbol]?: unknown
readonly [Unify.unifySymbol]?: ManagedRuntimeUnify<this>
readonly [Unify.ignoreSymbol]?: ManagedRuntimeUnifyIgnore
Expand Down
6 changes: 6 additions & 0 deletions packages/effect/src/internal/managedRuntime.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,12 @@ export const make = <R, ER>(
self.cachedRuntime = undefined
return Scope.close(self.scope, core.exitVoid)
}),
[Symbol.dispose](): void {
internalRuntime.unsafeRunEffect(self.disposeEffect)
},
[Symbol.asyncDispose](): Promise<void> {
return self.dispose()
},
runFork<A, E>(effect: Effect.Effect<A, E, R>, options?: Runtime.RunForkOptions): Fiber.RuntimeFiber<A, E | ER> {
return self.cachedRuntime === undefined ?
internalRuntime.unsafeForkEffect(provide(self, effect), options) :
Expand Down