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.

getMapping #

Retrieves the current mapping of this collection as a CollectionMapping object.

getMapping([options], callback) #

Arguments Type Description
options JSON object Optional parameters
callback function Callback handling the response

Options #

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

Callback Response #

Returns a CollectionMapping object.

Usage #

Copied to clipboard!
// Using callbacks (NodeJS or Web Browser)
  .collection('collection', 'index')
  .getMapping(function (error, result) {
    // result is a CollectionMapping object
// Using promises (NodeJS)
  .collection('collection', 'index')
  .then(result => {
    // result is a CollectionMapping object