PubSub | amplify-js

Hierarchy

PubSub

Index

Constructors

constructor

Methods

Constructors

constructor

new PubSub(options: PubSubOptions): PubSub

- Defined in packages/pubsub/src/PubSub.ts:61
Initialize PubSub with AWS configurations

Parameters
- options: PubSubOptions
  
  Configuration object for PubSub
Returns PubSub

Methods

addPluggable

addPluggable(pluggable: PubSubProvider): Promise<object>

- Defined in packages/pubsub/src/PubSub.ts:100
add plugin into Analytics category

Parameters
- pluggable: PubSubProvider
  
  an instance of the plugin
Returns Promise<object>

configure

configure(options: PubSubOptions): PubSubOptions

- Defined in packages/pubsub/src/PubSub.ts:85
Configure PubSub part with configurations

Parameters
- options: PubSubOptions
Returns PubSubOptions
- The current configuration

getModuleName

getModuleName(): string

- Defined in packages/pubsub/src/PubSub.ts:75
Returns string

publish

publish(topics: string[] | string, msg: any, options?: ProvidertOptions): Promise<void[]>

- Defined in packages/pubsub/src/PubSub.ts:137
Parameters
- topics: string[] | string
- msg: any
- Optional options: ProvidertOptions
Returns Promise<void[]>

subscribe

subscribe(topics: string[] | string, options?: ProvidertOptions): Observable<any>

- Defined in packages/pubsub/src/PubSub.ts:149
Parameters
- topics: string[] | string
- Optional options: ProvidertOptions
Returns Observable<any>