Interface BatchOperations<T>

batch

• batch(fn): Promise<void>

• Batch multiple operations together using a batch context, which wraps the underlying PathObject or Instance from which the batch was called. The batch context always contains a resolved instance, even when called from a PathObject. If an instance cannot be resolved from the referenced path, or if the instance is not a LiveObject, this method throws an error.

  Batching enables 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 in a single channel message once the batch function has completed.

  The objects' data is not modified inside the batch function. The batched operations are sent to Ably and, once accepted, applied locally. The returned promise resolves after all operations have been applied.

  Parameters

  • fn: BatchFunction<T>

    A synchronous function that receives a BatchContext used to group operations together.

  Returns Promise<void>

  A promise which resolves after all batched operations have been accepted by Ably and applied locally, or rejects with an ErrorInfo object upon failure.