RequestPayload #

Available since 2.8.0

The RequestPayload type represents an API request sent to Kuzzle in JSON format.

This type is meant to be used with the SDK query method.

See the API KuzzleRequest Format documentation.

Example:

import { RequestPayload } from 'kuzzle';

const requestPayload: RequestPayload = {
  controller: 'document',
  action: 'create',
  index: 'nyc-open-data',
  collection: 'yellow-taxi',
  body: {
    licence: 'B'
  }
};

Edit this page on Github