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

api.wait

Members

api.wait.forGameAction()

api.wait.forGameAction(action: GameAction, options?: WaitOptions | Duration.Input): Effect.Effect<boolean>
Name Type Required Default Description
action GameAction
options WaitOptions | Duration.Input { interval: "100 millis", timeout: "2 seconds" } Polling options or a timeout value.

Returns: boolean

Errors: never

api.wait.isGameActionAvailable()

api.wait.isGameActionAvailable(action: GameAction): Effect.Effect<boolean>
Name Type Required Default Description
action GameAction

Returns: boolean

Errors: never

api.wait.until()

api.wait.until(condition: Effect.Effect<boolean>, options?: WaitOptions): Effect.Effect<boolean>
Name Type Required Default Description
condition Effect.Effect<boolean>
options WaitOptions { interval: "100 millis", timeout: undefined } Polling options.

Returns: boolean

Errors: never

api.wait.untilSome()

api.wait.untilSome<A>(condition: Effect.Effect<Option.Option<A>>, options?: WaitOptions): Effect.Effect<A | null>
Name Type Required Default Description
condition Effect.Effect<Option.Option<A>>
options WaitOptions { interval: "100 millis", timeout: undefined } Polling options.

Returns: A | null

Errors: never

Type preview
Open page

Last updated on September 26, 2026

Was this page helpful?