SDK Javascript v5.x

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

room #

Creates a new Room object, using its constructor.

room([options]) #

Arguments Type Description
options object Subscription configuration

Options #

Provided options are passed directly to the Room object constructor.

Return Value #

Returns the newly created Room object.

Usage #

Copied to clipboard!
let room = kuzzle
  .collection('collection', 'index')
  .renew({in: {field: ['some', 'new', 'filter']}}, function (err, res) {
    // handle notifications