Interface Objects

Allows you to group multiple operations together and send them to the Ably service in a single channel message. As a result, other clients will receive the changes as a single channel message after the batch function has completed.

This method accepts a synchronous callback, which is provided with a BatchContext object. Use the context object to access Objects on a channel and batch operations for them.

The objects' data is not modified inside the callback function. Instead, the objects will be updated when the batched operations are applied by the Ably service and echoed back to the client.

Creates a new LiveCounter object instance with the provided count value.

Creates a new LiveMap object instance with the provided entries.

Retrieves the root LiveMap object for Objects on a channel.

A type parameter can be provided to describe the structure of the Objects on the channel. By default, it uses types from the globally defined AblyObjectsTypes interface.

You can specify custom types for Objects by defining a global AblyObjectsTypes interface with a root property that conforms to LiveMapType.

Example:

import { LiveCounter } from 'ably';

type MyRoot = {
  myTypedKey: LiveCounter;
};

declare global {
  export interface AblyObjectsTypes {
    root: MyRoot;
  }
}
Copy

Removes all registrations that match both the specified listener and the specified event.

Deregisters all registrations, for all events and listeners.

Registers the provided listener for the specified event. If on() is called more than once with the same listener and event, the listener is added multiple times to its listener registry. Therefore, as an example, assuming the same listener is registered twice using on(), and an event is emitted once, the listener would be invoked twice.