types_src.meshpubsub
Interface: MeshPubSub#
types/src.MeshPubSub
Table of contents#
Methods#
Methods#
asyncIterator#
â–¸ asyncIterator<THook\>(triggers: THook): AsyncIterator<AllHooks[THook], any, undefined\>
Type parameters:#
| Name | Type |
|---|---|
THook | string |
Parameters:#
| Name | Type |
|---|---|
triggers | THook |
Returns: AsyncIterator<AllHooks[THook], any, undefined\>
Defined in: packages/types/src/index.ts:68
publish#
â–¸ publish<THook\>(triggerName: THook, payload: AllHooks[THook]): Promise<void\>
Type parameters:#
| Name | Type |
|---|---|
THook | string |
Parameters:#
| Name | Type |
|---|---|
triggerName | THook |
payload | AllHooks[THook] |
Returns: Promise<void\>
Defined in: packages/types/src/index.ts:61
subscribe#
â–¸ subscribe<THook\>(triggerName: THook, onMessage: (data: AllHooks[THook]) => void, options?: any): Promise<number\>
Type parameters:#
| Name | Type |
|---|---|
THook | string |
Parameters:#
| Name | Type |
|---|---|
triggerName | THook |
onMessage | (data: AllHooks[THook]) => void |
options? | any |
Returns: Promise<number\>
Defined in: packages/types/src/index.ts:62
unsubscribe#
â–¸ unsubscribe(subId: number): void
Parameters:#
| Name | Type |
|---|---|
subId | number |
Returns: void
Defined in: packages/types/src/index.ts:67