Skip to content

scope-eval

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

scope-eval

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
box.test.ts
box.test.ts
 
 
box.ts
box.ts
 
 
eval-scope.test.ts
eval-scope.test.ts
 
 
eval-scope.ts
eval-scope.ts
 
 
mod.ts
mod.ts
 
 
package.json
package.json
 
 
tsconfig.json
tsconfig.json
 
 

README.md

@effectionx/scope-eval

Evaluate Effection operations in a scope while retaining resources.

While Scope.run and Scope.spawn can evaluate operations in isolated scopes, resources are torn down once operations return. useEvalScope allows you to invoke operations in an existing scope, receive the result of evaluations, while retaining resources for the lifecycle of that scope.

Usage

useEvalScope

Create a scope that evaluates operations and retains their resources:

import { main, createContext } from "effection";
import { useEvalScope } from "@effectionx/scope-eval";

await main(function*() {
  const context = createContext<string>("my-context");

  const evalScope = yield* useEvalScope();

  // Context not set yet
  evalScope.scope.get(context); // => undefined

  // Evaluate an operation that sets context
  yield* evalScope.eval(function*() {
    yield* context.set("Hello World!");
  });

  // Now the context is visible via the scope
  evalScope.scope.get(context); // => "Hello World!"
});

Error Handling

Operations are executed safely and return a Result<T>:

import { main } from "effection";
import { useEvalScope } from "@effectionx/scope-eval";

await main(function*() {
  const evalScope = yield* useEvalScope();

  const result = yield* evalScope.eval(function*() {
    throw new Error("something went wrong");
  });

  if (result.ok) {
    console.log("Success:", result.value);
  } else {
    console.log("Error:", result.error.message);
  }
});

box / unbox

Utilities for capturing operation results as values:

import { main } from "effection";
import { box, unbox } from "@effectionx/scope-eval";

await main(function*() {
  // Capture success or error as a Result
  const result = yield* box(function*() {
    return 42;
  });

  // Extract value (throws if error)
  const value = unbox(result); // => 42
});

API

useEvalScope(): Operation<EvalScope>

Creates an isolated scope for evaluating operations.

Returns an EvalScope with:

  • scope: Scope - The underlying Effection scope for inspecting context
  • eval<T>(op: () => Operation<T>): Operation<Result<T>> - Evaluate an operation

box<T>(content: () => Operation<T>): Operation<Result<T>>

Execute an operation and capture its result (success or error) as a Result<T>.

unbox<T>(result: Result<T>): T

Extract the value from a Result<T>, throwing if it's an error.

Use Cases

  • Testing: Evaluate operations and inspect context/state without teardown
  • Resource retention: Keep resources alive across multiple evaluations
  • Error boundaries: Safely execute operations that might fail