Skip to content
Lucent
Esc
↑↓navigate↵open
On this page

effect module

Effect utilities available to scripts.

require("effect") exposes a small set of Effect utilities.

Export Description
Effect Create and combine operations.
Option Represent a value that may be missing.
Duration Express a length of time.
pipe Pass a value through a series of functions.

Supported members

Example: bound a long-running action

const api = require("lucent/api");
const script = require("lucent/script");
const { Effect, Option, pipe } = require("effect");

module.exports = function* run() {
  const result = yield* pipe(
    api.combat.kill("Boss Name"),
    Effect.timeoutOption("30 seconds"),
  );

  if (Option.isNone(result)) {
    yield* script.log("The kill timed out.");
  }
};
Type preview
Open page

Last updated on September 26, 2026

Was this page helpful?