HubClass | amplify-js

Hierarchy

HubClass

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new HubClass(name: string): HubClass

- Defined in packages/core/src/Hub.ts:67
Parameters
- name: string
Returns HubClass

Properties

name

name: string

protectedChannels

protectedChannels: string[] = ['core','auth','api','analytics','interactions','pubsub','storage','xr',]

Methods

dispatch

dispatch(channel: string, payload: HubPayload, source?: string, ampSymbol?: Symbol): void

- Defined in packages/core/src/Hub.ts:96
Parameters
- channel: string
- payload: HubPayload
- Default value source: string = ""
- Optional ampSymbol: Symbol
Returns void

listen

listen(channel: string | RegExp, callback?: HubCallback | LegacyCallback, listenerName?: string): void

- Defined in packages/core/src/Hub.ts:126
Parameters
- channel: string | RegExp
- Optional callback: HubCallback | LegacyCallback
- Default value listenerName: string = "noname"
Returns void

remove

remove(channel: string | RegExp, listener: HubCallback): void

- Defined in packages/core/src/Hub.ts:74
Parameters
- channel: string | RegExp
- listener: HubCallback
Returns void