Observer

CORE · type · Type contract

Notification callback. A rejected promise propagates to the emitter.

Import

TypeScript

import type { Observer } from '@jangts/agent-core';

JavaScript

/** @typedef {import('@jangts/agent-core').Observer} Observer */

Other public entry points:@jangts/agent-core, @jangts/agent-core/types, @jangts/agent-core/structs.

Definition

type Observer<Event> = (event: Readonly<Event>) => void | Promise<void>;

Type parameters

Type parameter	Constraint	Default type
Event	—	—

Call

Observer(event: Readonly<Event>): void | Promise<void>

Parameter	Type	Passing	Description
event	Readonly<Event>	Required	—

Returns: void \| Promise<void>.

Awaited value: void.

Using the type

When using this type, choose type arguments from the table above; parameters with defaults may be omitted.