Interface SubscribeOptions<Msg, Opts>

Options for .

interface SubscribeOptions {
    signal?: AbortSignal;
    topic?: string;
    validator?: MessageValidator<Msg, Opts>;
}

Type Parameters

Msg
Opts = object

Hierarchy

MessageOptions
- SubscribeOptions

Index

Properties

signal? topic? validator?

Properties

`Optional` signal

signal?: AbortSignal

An optional AbortSignal that can be used to abort an async task.

`Optional` `Readonly` topic

topic?: string

The message's topic.

`Optional` validator

validator?: MessageValidator<Msg, Opts>

Message validator for the topic.

Generated using TypeDoc