SDK
SDK Javascript v5.x
1

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.

collectionMapping #

Creates a new CollectionMapping object, using its constructor.


collectionMapping([mapping]) #

ArgumentsTypeDescription
mappingJSON ObjectOptional mapping

Return Value #

Returns the newly created CollectionMapping object.

Usage #

let dataMapping = kuzzle
  .collection('collection', 'index')
  .collectionMapping({someField: {type: 'string', index: 'analyzed'}})
  .apply(function (error, result) {
    // called once the mapping action has been completed
  });