updateUserMapping #

Updates the internal user storage mapping.

updateUserMapping(mapping, [options]);

Property	Type	Description
`mapping`	object	User collection mapping definition
`options`	object	Query options

options #

Property	Type (default)	Description
`queuable`	boolean (`true`)	If `true`, queues the request during downtime, until connected to Kuzzle again
`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 an object representing the new mapping.

Usage #

try {
  const updatedMapping = await kuzzle.security.updateUserMapping({
    properties: {
      firstName: { type: 'text' },
      lastName: { type: 'text' },
      birthDate: {
        type: 'date',
        format: 'yyyy-mm-dd'
      }
    }
  });
  console.log(updatedMapping);
  /*
    {
      properties: {
        firstName: { type: 'text' },
        lastName: { type: 'text' },
        birthDate: {
          type: 'date',
          format: 'yyyy-mm-dd'
        }
      }
    }
  */
} catch (e) {
  console.error(e);
}

Edit this page on Github