ws-asyncapi API / core / ServerPlugin

Interface: ServerPlugin

Defined in: .api-entries/core/index.d.ts:67

Properties

name?

optional name?: string

Defined in: .api-entries/core/index.d.ts:69

optional name (diagnostics)

Methods

onConnection()?

optional onConnection(ctx): void | Promise<void>

Defined in: .api-entries/core/index.d.ts:71

a connection opened (after derives/onOpen ran)

Parameters

ctx

ServerPluginContext & object

Returns

void | Promise<void>

---

onDisconnect()?

optional onDisconnect(ctx): void | Promise<void>

Defined in: .api-entries/core/index.d.ts:75

a connection closed

Parameters

ctx

ServerPluginContext

Returns

void | Promise<void>

---

onMessage()?

optional onMessage(ctx): void | Promise<void>

Defined in: .api-entries/core/index.d.ts:78

an inbound frame was received (kind is the numeric Frame; name is the event/command/rpc/stream name when the frame carries one)

Parameters

ctx

ServerPluginContext & object

Returns

void | Promise<void>

---

onError()?

optional onError(ctx): void | Promise<void>

Defined in: .api-entries/core/index.d.ts:83

a command/middleware/handler error surfaced

Parameters

ctx

ServerPluginContext & object

Returns

void | Promise<void>