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.

refresh #

Creates a new Document object with the last version of this document stored in Kuzzle.

refresh([options], callback) #

Arguments Type Description
options JSON Object Optional parameters
callback function Callback

Options #

Option Type Description Default
queuable boolean Make this request queuable or not true

Callback Response #

Return a new Document object containing the last document version.

Usage #

Copied to clipboard!
// Using callbacks (NodeJS or Web Browser)
document.refresh(function (error, result) {
  // called once the refresh action has been completed
// Using promises (NodeJS)
document.refreshPromise().then(result => {
  // called once the refresh action has been completed