https://github.com/ably/ably-js
Javascript, Node, Typescript, React, React Native client library SDK for Ably realtime messaging service
https://github.com/ably/ably-js
client-library javascript js react-native realtime realtime-messaging rest sdk ts typescript
Last synced: 2 days ago
JSON representation
Javascript, Node, Typescript, React, React Native client library SDK for Ably realtime messaging service
- Host: GitHub
- URL: https://github.com/ably/ably-js
- Owner: ably
- License: apache-2.0
- Created: 2012-11-13T19:41:13.000Z (about 13 years ago)
- Default Branch: main
- Last Pushed: 2025-05-08T17:20:38.000Z (8 months ago)
- Last Synced: 2025-05-08T17:23:21.034Z (8 months ago)
- Topics: client-library, javascript, js, react-native, realtime, realtime-messaging, rest, sdk, ts, typescript
- Language: JavaScript
- Homepage: https://ably.com/download
- Size: 31.2 MB
- Stars: 333
- Watchers: 31
- Forks: 59
- Open Issues: 198
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://img.shields.io/npm/v/ably.svg?style=flat)
[](https://github.com/ably/ably-js/blob/main/LICENSE)
---
# Ably Pub/Sub JavaScript SDK
Build any realtime experience using Ably’s Pub/Sub JavaScript SDK. Supported on all popular platforms and frameworks, including Node, React, and Web Workers.
Ably Pub/Sub provides flexible APIs that deliver features such as pub-sub messaging, message history, presence, and push notifications. Utilizing Ably’s realtime messaging platform, applications benefit from its highly performant, reliable, and scalable infrastructure.
Ably LiveObjects is also available as a Pub/Sub JavaScript SDK plugin. You can use LiveObjects to synchronize application state across your clients at scale.
Find out more:
- [Ably Pub/Sub docs](https://ably.com/docs/basics)
- [Ably Pub/Sub Examples](https://ably.com/examples?product=pubsub)
---
## Getting started
Everything you need to get started with Ably:
- [Getting started with Pub/Sub in JavaScript](https://ably.com/docs/getting-started/javascript)
- [Getting started with Pub/Sub in React](https://ably.com/docs/getting-started/react)
- [Getting started with LiveObjects in JavaScript](https://ably.com/docs/liveobjects/quickstart)
---
## Supported platforms
Ably aims to support a wide range of platforms and all current browser versions, including Chrome, Firefox, Safari, Microsoft Edge, and other modern browsers. If you experience any compatibility issues, open an issue in the repository or contact [Ably support](https://ably.com/support).
The following platforms are supported:
| Platform | Support |
| ----------- | ---------------------------------------------------------------------------------------- |
| JavaScript | ES2017 |
| Node.js | See `engines` in [package.json](https://github.com/ably/ably-js/blob/main/package.json). |
| React | >=16.8.x |
| TypeScript | Type definitions are included in the package. |
| Web Workers | Browser bundle and [modular](#modular-variant) support. |
> [!NOTE]
> Versions 1.2.x of the SDK support Internet Explorer >=9 and other older browsers, as well as Node.js >=8.17.
> [!IMPORTANT]
> SDK versions < 1.2.36 will be [deprecated](https://ably.com/docs/platform/deprecate/protocol-v1) from November 1, 2025.
---
## Installation
The JavaScript SDK is available as an [NPM module](https://www.npmjs.com/package/ably). To get started with your project, install the package:
```sh
npm install ably
```
You can also source it directly in your HTML. (This url will point to the latest version of v2 of the SDK, the current major version, avoiding breaking changes per semver)
```html
```
## Usage
The following code connects to Ably's realtime messaging service, subscribes to a channel to receive messages, and publishes a test message to that same channel.
```javascript
// Initialize Ably Realtime client
// (for the REST client use new Ably.Rest({...}) instead)
const realtimeClient = new Ably.Realtime({ key: 'your-ably-api-key', clientId: 'me' });
// Wait for connection to be established
await realtimeClient.connection.once('connected');
console.log('Connected to Ably');
// Get a reference to the 'test-channel' channel
const channel = realtimeClient.channels.get('test-channel');
// Subscribe to all messages published to this channel
await channel.subscribe((message) => {
console.log(`Received message: ${message.data}`);
});
// Publish a test message to the channel
await channel.publish('test-event', 'hello world');
```
## Modular variant
The Pub/Sub SDK has a modular (tree-shakable) variant to build with a small bundle sizes.
Modular variant details.
Aimed at those who are concerned about their app's bundle size, the modular variant of the library allows you to create a client which has only the functionality that you choose. Unused functionality can then be tree-shaken by your module bundler.
The modular variant of the library provides:
- A `BaseRealtime` class;
- various plugins that add functionality to a `BaseRealtime` instance, such as `Rest`, `RealtimePresence`, etc.
To use this variant of the library, import the `BaseRealtime` class from `ably/modular`, along with the plugins that you wish to use. Then, pass these plugins to the `BaseRealtime` constructor as shown in the example below:
```javascript
import { BaseRealtime, WebSocketTransport, FetchRequest, RealtimePresence } from 'ably/modular';
const client = new BaseRealtime({
key: 'YOUR_ABLY_API_KEY', // Replace with a real key from the Ably dashboard
plugins: {
WebSocketTransport,
FetchRequest,
RealtimePresence,
},
});
```
You must provide:
- At least one HTTP request implementation; that is, one of `FetchRequest` or `XHRRequest`;
- At least one realtime transport implementation; that is, one of `WebSocketTransport` or `XHRPolling`.
`BaseRealtime` offers the same API as the `Realtime` class described in the rest of this `README`. This means that you can develop an application using the default variant of the SDK and switch to the modular version when you wish to optimize your bundle size.
In order to further reduce bundle size, the modular variant of the SDK performs less logging than the default variant. It only logs:
- Messages that have a `logLevel` of 1 (that is, errors)
- A small number of other network events
If you require more verbose logging, use the default variant of the SDK.
For more information view the [TypeDoc references](https://sdk.ably.com/builds/ably/ably-js/main/typedoc/modules/modular.html).
---
## Contribute
Read the [CONTRIBUTING.md](./CONTRIBUTING.md) guidelines to contribute to Ably.
---
## Releases
The [CHANGELOG.md](/ably/ably-js/blob/main/CHANGELOG.md) contains details of the latest releases for this SDK. You can also view all Ably releases on [changelog.ably.com](https://changelog.ably.com).
---
## Support, feedback, and troubleshooting
For help or technical support, visit Ably's [support page](https://ably.com/support) or [GitHub Issues](https://github.com/ably/ably-js-nativescript/issues) for community-reported bugs and discussions.
### Chrome extensions
Ably Pub/Sub works out-of-the-box in background scripts for Chrome extensions using manifest v2. However, since manifest v3 background pages are no longer supported, you will need to run Ably Pub/Sub JavaScript SDK inside a service worker.
Chrome extensions support details.
If you are using this SDK in a service worker, note:
- In versions of Chrome before 116, active WebSockets would not reset the 30s service worker idle timer, resulting in the client being closed prematurely.
- In versions 116 and above, service workers will stay active as long as a client is connected.
To ensure compatibility, add the following to your `manifest.json`:
If you are using this SDK's realtime features, for example, WebSockets in a service worker, note:
- In versions of Chrome before 116, active WebSockets would not reset the 30s service worker idle timer, resulting in the client being closed prematurely.
- In versions 116 and above, service workers will stay active as long as a client is connected.
To ensure compatibility, add the following to your `manifest.json`:
```json
{
// ...
"minimum_chrome_version": "116"
// ...
}
```
### "Connection limit exceeded" errors during development
If you're hitting a "connection limit exceeded" error and see rising connection counts in your Ably dashboard, it's likely due to multiple `Ably.Realtime` instances being created during development.
"Connection limit exceeded" support details.
Even for `use client` components, Next.js may execute them on the server during pre-rendering. This can create unintended `Ably.Realtime` connections from Node.js that remain open until you restart the development server.
Prevent server-side connections using `autoConnect` and a window check:
```typescript
const client = new Ably.Realtime({
key: 'your-ably-api-key',
autoConnect: typeof window !== 'undefined',
});
```
Creating the client inside [React](https://github.com/ably/ably-js/blob/main/docs/react.md#Usage) components can lead to a new connection on every render. To prevent this, move the new `Ably.Realtime()` call outside of component functions.
In development environments that use Hot Module Replacement (HMR), such as React, Vite, or Next.js, saving a file can recreate the Ably.Realtime client, while previous instances remain connected. Over time, this leads to a growing number of active connections with each code edit. To fix: Move the client to a separate file (e.g., `ably-client.js`) and import it. This ensures the client is recreated only when that file changes.
### Next.js with App Router and Turbopack
If you encounter a `Failed to compile Module not found` error or warnings related to `keyv` when using Ably Pub/Sub JavaScript SDK with [Next.js](https://nextjs.org/docs/app/api-reference/next-config-js/serverComponentsExternalPackages), add `ably` to the `serverComponentsExternalPackages` list in `next.config.js`.
Next.js with App Router and Turbopack support details.
The following example adds `ably` to the `serverComponentsExternalPackages` list in `next.config.js`:
```javascript
const nextConfig = {
// ...
experimental: {
serverComponentsExternalPackages: ['ably'],
},
};
```
The issue is coming from the fact that when using App Router specifically, dependencies used inside Server Components and Route Handlers will automatically be bundled by Next.js. This causes issues with some packages, usually the ones that have complex `require` statements, for example, requiring some packages dynamically during runtime. `keyv` is one of those packages as it uses `require` statement dynamically when requiring its adapters (see [code in repo](https://github.com/jaredwray/keyv/blob/main/packages/keyv/src/index.ts#L102)):
`keyv` ends up being one of `ably-js`'s upstream dependencies for the node.js bundle, which causes the errors above when using it with Next.js App Router.
Using `serverComponentsExternalPackages` opts out from using Next.js bundling for specific packages and uses native Node.js `require` instead.
This is a common problem in App Router for a number of packages (for example, see next.js issue [vercel/next.js#52876](https://github.com/vercel/next.js/issues/52876)), and using `serverComponentsExternalPackages` is the recommended approach here.
### Genral errors during development
If you encounter an error such as `connection limit exceeded` during development, it may be caused by several issues.
General errors support details.
#### Server-side rendering (SSR)
Use the `autoConnect` option to prevent the client from connecting when rendered on the server:
```typescript
const client = new Ably.Realtime({ key: 'your-ably-api-key', autoConnect: typeof window !== 'undefined' });
```
#### Component re-renders
Avoid creating the client inside React components. Instead, move the client instantiation outside of the component to prevent it from being recreated on every render.
#### Hot module replacement (HMR)
To avoid duplicate client instances caused by hot reloads, move the new `Ably.Realtime()` call into a separate file, for example, `ably.js` and export the client from there. This ensures a single shared instance is reused during development.