@aws-amplify/pubsub
- Version 6.1.20
- Published
- 518 kB
- 6 dependencies
- Apache-2.0 license
Install
npm i @aws-amplify/pubsub
yarn add @aws-amplify/pubsub
pnpm add @aws-amplify/pubsub
Overview
Pubsub category of aws-amplify
Index
Variables
Functions
Classes
Interfaces
Enums
Variables
variable CONNECTION_STATE_CHANGE
const CONNECTION_STATE_CHANGE: string;
Functions
function mqttTopicMatch
mqttTopicMatch: (filter: string, topic: string) => boolean;
Classes
class PubSub
class AWSIoT extends MqttOverWS {}
constructor
constructor(options?: AWSIoTOptions);
property endpoint
readonly endpoint: Promise<string>;
property region
readonly region: string;
Interfaces
interface PubSubOptions
interface AWSIoTOptions extends MqttOptions {}
Enums
enum ConnectionState
enum ConnectionState { Connected = 'Connected', ConnectedPendingNetwork = 'ConnectedPendingNetwork', ConnectionDisrupted = 'ConnectionDisrupted', ConnectionDisruptedPendingNetwork = 'ConnectionDisruptedPendingNetwork', Connecting = 'Connecting', ConnectedPendingDisconnect = 'ConnectedPendingDisconnect', Disconnected = 'Disconnected', ConnectedPendingKeepAlive = 'ConnectedPendingKeepAlive',}
{string}
member Connected
Connected = 'Connected'
member ConnectedPendingDisconnect
ConnectedPendingDisconnect = 'ConnectedPendingDisconnect'
member ConnectedPendingKeepAlive
ConnectedPendingKeepAlive = 'ConnectedPendingKeepAlive'
member ConnectedPendingNetwork
ConnectedPendingNetwork = 'ConnectedPendingNetwork'
member Connecting
Connecting = 'Connecting'
member ConnectionDisrupted
ConnectionDisrupted = 'ConnectionDisrupted'
member ConnectionDisruptedPendingNetwork
ConnectionDisruptedPendingNetwork = 'ConnectionDisruptedPendingNetwork'
member Disconnected
Disconnected = 'Disconnected'
enum CONTROL_MSG
enum CONTROL_MSG { CONNECTION_CLOSED = 'Connection closed', CONNECTION_FAILED = 'Connection failed', REALTIME_SUBSCRIPTION_INIT_ERROR = 'AppSync Realtime subscription init error', SUBSCRIPTION_ACK = 'Subscription ack', TIMEOUT_DISCONNECT = 'Timeout disconnect',}
member CONNECTION_CLOSED
CONNECTION_CLOSED = 'Connection closed'
member CONNECTION_FAILED
CONNECTION_FAILED = 'Connection failed'
member REALTIME_SUBSCRIPTION_INIT_ERROR
REALTIME_SUBSCRIPTION_INIT_ERROR = 'AppSync Realtime subscription init error'
member SUBSCRIPTION_ACK
SUBSCRIPTION_ACK = 'Subscription ack'
member TIMEOUT_DISCONNECT
TIMEOUT_DISCONNECT = 'Timeout disconnect'
Package Files (5)
Dependencies (6)
Dev Dependencies (2)
Peer Dependencies (1)
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@aws-amplify/pubsub
.
- Markdown[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@aws-amplify/pubsub)
- HTML<a href="https://www.jsdocs.io/package/@aws-amplify/pubsub"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 3545 ms. - Missing or incorrect documentation? Open an issue for this package.