Class SvSubscriber<ME>

SVS-PS subscriber.

Type Parameters

ME extends MappingEntry = MappingEntry
Subclass of MappingEntry. If it is not MappingEntry base class, its constructor must be specified in SvSubscriber.Options.mappingEntryType.

Hierarchy

TypedEventTarget<EventMap>
- SvSubscriber

Implements

Subscriber<Name, SvSubscriber.Update, SubscribeInfo<ME>>

Index

Constructors

Methods

close subscribe

Constructors

constructor

new SvSubscriber<ME extends MappingEntry = MappingEntry>(
__namedParameters: SvSubscriber.Options,
): SvSubscriber<ME>
Type Parameters
- ME extends MappingEntry = MappingEntry
  Subclass of MappingEntry. If it is not MappingEntry base class, its constructor must be specified in SvSubscriber.Options.mappingEntryType.
Parameters
- __namedParameters: SvSubscriber.Options
Returns SvSubscriber<ME>
Overrides TypedEventTarget<EventMap>.constructor
- Defined in pkg/svs/src/subscriber.ts:28

Methods

close

close(): void
Stop subscriber operations.

Returns void
Remarks
This does not stop the SvSync instance.
- Defined in pkg/svs/src/subscriber.ts:95

subscribe(topic: SubscribeInfo<ME>): Subscription<Name, SvSubscriber.Update>
Subscribe to either a topic prefix or a publisher node ID.
Parameters
- topic: SubscribeInfo<ME>
Returns Subscription<Name, SvSubscriber.Update>
Implementation of Subscriber.subscribe
- Defined in pkg/svs/src/subscriber.ts:100