unsubscribe #

Removes a subscription.

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 (`-1`)	Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely
`triggerEvents`	boolean (`false`)	If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. Available since Kuzzle 2.31.0

Resolves #

Resolves if successfuly unsubscribed.

Usage #

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);
}

Edit this page on Github