Class SvPublisher

SVS-PS publisher.

Index

Constructors

Accessors

Methods

Constructors

constructor

new SvPublisher(__namedParameters: SvPublisher.Options): SvPublisher
Parameters
- __namedParameters: SvPublisher.Options
Returns SvPublisher
- Defined in pkg/svs/src/publisher.ts:18

Accessors

id

get id(): Name
Publisher node ID.

Returns Name
- Defined in pkg/svs/src/publisher.ts:66

Methods

close

close(): Promise<void>
Stop publisher operations.

Returns Promise<void>
Remarks
This does not stop the SvSync instance or the SvPublisher.DataStore.
- Defined in pkg/svs/src/publisher.ts:74

publish

publish(
    name: NameLike,
    payload: Uint8Array<ArrayBufferLike>,
    entry?: MappingEntry,
): Promise<number>
Publish application data.
Parameters
- name: NameLike
  Application-specified inner name.
- payload: Uint8Array<ArrayBufferLike>
  Application payload.
- entry: MappingEntry = ...
  MappingEntry for subscriber-side filtering. This is required if subscribers are expecting a certain MappingEntry subclass.
Returns Promise<number>
seqNum.
- Defined in pkg/svs/src/publisher.ts:88