Op

Op<Args, E, A> = object

Defined in: Core/Op.ts:113

A reusable description of asynchronous work.

Op.interpret creates a manager that runs the work and controls overlapping calls. Each caller receives its own outcome, while the manager exposes its current state to subscribers.

Example

const fetchUser = Op.make((id: string) =>
  Task.Result.tryCatch(
    (signal) =>
      fetch(`/users/${id}`, { signal }).then((r) => {
        if (!r.ok) throw new Error(`${r.status} ${r.statusText}`);
        return r.json() as Promise<User>;
      }),
    { onError: (error): ApiError => new ApiError(String(error)) },
  )
);

const manager = Op.interpret(fetchUser, { strategy: "restartable" });
manager.subscribe(state => {
  if (Op.is.pending(state)) showSpinner();
  if (Op.Outcome.is.ok(state)) render(state.value);
  if (Op.Outcome.is.err(state)) showError(state.error);
  if (Op.Outcome.is.nil(state)) resetUI();
});
manager.run(userId);

Type Parameters

Args

Args extends readonly unknown[] = readonly unknown[]

E

E = unknown

A

A = unknown

Properties

[_opBrand]

readonly [_opBrand]: object

Defined in: Core/Op.ts:119

_args

readonly _args: (…args) => void

Parameters

args

…Args

Returns

void

_error

readonly _error: () => E

Returns

E

_value

readonly _value: () => A

Returns

A

---

[toStringTag]?

readonly optional [toStringTag]?: string

Defined in: Core/Op.ts:118

---

id?

readonly optional id?: string

Defined in: Core/Op.ts:117

An optional diagnostic identifier for this operation blueprint.