API reference@evolu/commonTask › Gate

Defined in: packages/common/src/Task.ts:2296

A blocking Task — like a gate.

  • Closed: Tasks wait.
  • Open: Tasks proceed.

Use it to pause execution based on a condition. Unlike a Deferred (which triggers once), a Gate can be opened and closed repeatedly.

Disposing aborts all waiting Tasks with deferredDisposedError.

See

createGate

Extends

Methods

[dispose]()

dispose: void;

Defined in: node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/lib.esnext.disposable.d.ts:36

Inherited from

Disposable.[dispose]

Properties

close

readonly close: () => void;

Defined in: packages/common/src/Task.ts:2299

isOpen

readonly isOpen: () => boolean;

Defined in: packages/common/src/Task.ts:2300

open

readonly open: () => void;

Defined in: packages/common/src/Task.ts:2298

wait

readonly wait: Task<void, DeferredDisposedError, D>;

Defined in: packages/common/src/Task.ts:2297