count

Returns the number of other connections sharing the same subscription.

Arguments

Copied to clipboard!
count(roomId, [options]);

Arguments Type Description
roomId
string
Subscription room ID
options
object
Query options

options

Additional query options

Option Type
(default)
Description
queuable
boolean

(true)
Make this request queuable or not

Resolves

Resolves to a number represensting active connections using the same provided subscription room.

Usage

Copied to clipboard!
try {
  const roomId = await kuzzle.realtime.subscribe(
    'nyc-open-data',
    'yellow-taxi',
    {},
    () => {}
  );

  const count = await kuzzle.realtime.count(roomId);

  console.log(`Currently ${count} active subscription`);
} catch (error) {
  console.error(error.message);
}