unsubscribe #

Removes a subscription.

Copied to clipboard!

unsubscribe(roomId, [options]);

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

options #

Additional query options

Option	Type (default)	Description
queuable	bool (true)	Make this request queuable or not
timeout	number	Time (in ms) during which a request will still be waited to be resolved. Set it -1 if you want to wait indefinitely

Resolves #

Resolves if successfuly unsubscribed.

Usage #

Copied to clipboard!

try {
  const roomId = await kuzzle.realtime.subscribe(
    'nyc-open-data',
    'yellow-taxi',
    {},
    () => {}
  );
  await kuzzle.realtime.unsubscribe(roomId);
  console.log('Success');
} catch (error) {
  console.error(error.message);
}