AsyncSink

CORE · type · Type contract

Awaitable sink for an ordered stream. A rejection propagates to the emitter.

Import

TypeScript

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

JavaScript

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

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

Definition

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

Type parameters

Type parameter	Constraint	Default type
Event	—	—

Call

AsyncSink(event: Readonly<Event>): Promise<void>

Parameter	Type	Passing	Description
event	Readonly<Event>	Required	—

Returns: 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.