-
-
Notifications
You must be signed in to change notification settings - Fork 231
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
381 additions
and
262 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| /** | ||
| * @since 2.0.0 | ||
| */ | ||
| import type * as Effect from "./Effect.js" | ||
| import type * as Exit from "./Exit.js" | ||
| import type * as Fiber from "./Fiber.js" | ||
| import * as internal from "./internal/managedRuntime.js" | ||
| import type * as Layer from "./Layer.js" | ||
| import type { Pipeable } from "./Pipeable.js" | ||
| import type * as Runtime from "./Runtime.js" | ||
|
|
||
| /** | ||
| * @since 2.0.0 | ||
| * @category models | ||
| */ | ||
| export interface ManagedRuntime<in R, out E> extends Pipeable, AsyncDisposable { | ||
| readonly memoMap: Layer.MemoMap | ||
| readonly runtime: Effect.Effect<Runtime.Runtime<R>, E> | ||
| } | ||
|
|
||
| /** | ||
| * Convert a Layer into an ManagedRuntime, than can be used to run Effect's using | ||
| * your services. | ||
| * | ||
| * @since 2.0.0 | ||
| * @category runtime class | ||
| * @example | ||
| * import { Console, Effect, Layer, ManagedRuntime } from "effect" | ||
| * | ||
| * class Notifications extends Effect.Tag("Notifications")< | ||
| * Notifications, | ||
| * { readonly notify: (message: string) => Effect.Effect<void> } | ||
| * >() { | ||
| * static Live = Layer.succeed(this, { notify: (message) => Console.log(message) }) | ||
| * } | ||
| * | ||
| * async function main() { | ||
| * const runtime = ManagedRuntime.make(Notifications.Live) | ||
| * const runPromise = ManagedRuntime.runPromise(runtime) | ||
| * await runPromise(Notifications.notify("Hello, world!")) | ||
| * await ManagedRuntime.dispose(runtime) | ||
| * } | ||
| * | ||
| * main() | ||
| */ | ||
| export const make: <R, E>( | ||
| layer: Layer.Layer<R, E, never>, | ||
| memoMap?: Layer.MemoMap | undefined | ||
| ) => ManagedRuntime<R, E> = internal.make | ||
|
|
||
| /** | ||
| * Executes the effect using the provided Scheduler or using the global | ||
| * Scheduler if not provided | ||
| * | ||
| * @since 2.0.0 | ||
| * @category execution | ||
| */ | ||
| export const runFork: <R, ER>( | ||
| runtime: ManagedRuntime<R, ER> | ||
| ) => <A, E>(self: Effect.Effect<A, E, R>, options?: Runtime.RunForkOptions) => Fiber.RuntimeFiber<A, E | ER> = | ||
| internal.runFork | ||
|
|
||
| /** | ||
| * Executes the effect synchronously returning the exit. | ||
| * | ||
| * This method is effectful and should only be invoked at the edges of your | ||
| * program. | ||
| * | ||
| * @since 2.0.0 | ||
| * @category execution | ||
| */ | ||
| export const runSyncExit: <R, ER>( | ||
| self: ManagedRuntime<R, ER> | ||
| ) => <A, E>(effect: Effect.Effect<A, E, R>) => Exit.Exit<A, ER | E> = internal.runSyncExit | ||
|
|
||
| /** | ||
| * Executes the effect synchronously throwing in case of errors or async boundaries. | ||
| * | ||
| * This method is effectful and should only be invoked at the edges of your | ||
| * program. | ||
| * | ||
| * @since 2.0.0 | ||
| * @category execution | ||
| */ | ||
| export const runSync: <R, ER>(self: ManagedRuntime<R, ER>) => <A, E>(effect: Effect.Effect<A, E, R>) => A = | ||
| internal.runSync | ||
|
|
||
| /** | ||
| * Executes the effect asynchronously, eventually passing the exit value to | ||
| * the specified callback. | ||
| * | ||
| * This method is effectful and should only be invoked at the edges of your | ||
| * program. | ||
| * | ||
| * @since 2.0.0 | ||
| * @category execution | ||
| */ | ||
| export const runCallback: <R, ER>( | ||
| runtime: ManagedRuntime<R, ER> | ||
| ) => <A, E>( | ||
| effect: Effect.Effect<A, E, R>, | ||
| options?: Runtime.RunCallbackOptions<A, E | ER> | undefined | ||
| ) => Runtime.Cancel<A, E | ER> = internal.runCallback | ||
|
|
||
| /** | ||
| * Runs the `Effect`, returning a JavaScript `Promise` that will be resolved | ||
| * with the value of the effect once the effect has been executed, or will be | ||
| * rejected with the first error or exception throw by the effect. | ||
| * | ||
| * This method is effectful and should only be used at the edges of your | ||
| * program. | ||
| * | ||
| * @since 2.0.0 | ||
| * @category execution | ||
| */ | ||
| export const runPromise: <R, ER>(self: ManagedRuntime<R, ER>) => <A, E>(effect: Effect.Effect<A, E, R>) => Promise<A> = | ||
| internal.runPromise | ||
|
|
||
| /** | ||
| * Runs the `Effect`, returning a JavaScript `Promise` that will be resolved | ||
| * with the `Exit` state of the effect once the effect has been executed. | ||
| * | ||
| * This method is effectful and should only be used at the edges of your | ||
| * program. | ||
| * | ||
| * @since 2.0.0 | ||
| * @category execution | ||
| */ | ||
| export const runPromiseExit: <R, ER>( | ||
| self: ManagedRuntime<R, ER> | ||
| ) => <A, E>(effect: Effect.Effect<A, E, R>) => Promise<Exit.Exit<A, ER | E>> = internal.runPromiseExit | ||
|
|
||
| /** | ||
| * Dispose of the resources associated with the runtime. | ||
| * | ||
| * @since 2.0.0 | ||
| * @category finalization | ||
| */ | ||
| export const dispose: <R, E>(self: ManagedRuntime<R, E>) => Promise<void> = internal.dispose | ||
|
|
||
| /** | ||
| * Dispose of the resources associated with the runtime. | ||
| * | ||
| * @since 2.0.0 | ||
| * @category finalization | ||
| */ | ||
| export const disposeEffect: <R, E>(self: ManagedRuntime<R, E>) => Effect.Effect<void, never, never> = | ||
| internal.disposeEffect |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.