Interface Connection

Represents a connection to Ably.

interface Connection {
    get error(): undefined | ErrorInfo;
    get status(): ConnectionStatus;
    dispose(): void;
    onStatusChange(listener: ConnectionStatusListener): StatusSubscription;
}

Index

Accessors

Methods

dispose onStatusChange

Accessors

error

get error(): undefined | ErrorInfo
The current error, if any, that caused the connection to enter the current status.

Returns undefined | ErrorInfo
- Defined in src/core/connection.ts:87

status

get status(): ConnectionStatus
The current status of the connection.

Returns ConnectionStatus
- Defined in src/core/connection.ts:82

Methods

dispose

dispose(): void
Disposes of the connection instance, cleaning up any registered listeners. This method should be called when the connection is no longer needed.

Returns void
- Defined in src/core/connection.ts:100

onStatusChange

onStatusChange(listener: ConnectionStatusListener): StatusSubscription
Registers a listener that will be called whenever the connection status changes.
Parameters
- listener: ConnectionStatusListener
  The function to call when the status changes.
Returns StatusSubscription
An object that can be used to unregister the listener.
- Defined in src/core/connection.ts:94