Guides v2.x

KuzzleRequest #

Object representation of a Kuzzle API call, to be used with the entryPoint.execute function.

That object is continuously updated to reflect the current state of the request, during its entire lifecycle.

For more information about this object, refer to its technical documentation.

Response headers #

Network protocol specific headers can be added to the response. If the protocol supports it, these headers are forwarded in the response sent to the client.

To customize the response content, read the RequestResponse documentation.

Constructor #

Copied to clipboard!
new KuzzleRequest(data, [options]);

Arguments Type Description
data object API call, following the same format than non-HTTP API calls
options object Additional request context

options #

The options object can contain the following properties:

Properties Type Description
connection object Connection information (see the connection class documentation)

| error | KuzzleError,
Error | Sets the request response with the provided error | | requestId | string | User-defined request identifier | | result | * | Sets the request response with the provided result, and the request status is set to 200 | | status | integer | KuzzleRequest status, following the HTTP error code standard |

Properties #


Properties Type Description
context RequestContext General request information (logged user, network information, ...)
error KuzzleError KuzzleRequest error
input RequestInput Input request representation
response RequestResponse Serialized request response
result * KuzzleRequest result
timestamp integer KuzzleRequest creation timestamp, in Epoch-millis format


Properties Type Description
id string User-defined request unique identifier
status integer KuzzleRequest status code

clearError #

Clears the error: sets the error property to null, and the request status to 200.

serialize #

Serializes the request into into a pair of objects that can be sent across the network.

Example #

Copied to clipboard!
const foo = request.serialize();
const bar = new context.KuzzleRequest(, foo.options);

setError #

Adds an error to the request.

The request status is also updated to the error status.

Argument #

Copied to clipboard!

Arguments Type Description
error KuzzleError, Error KuzzleRequest error

If a KuzzleError object is provided, the request's status attribute is set to the error one.

Otherwise, the provided error is embedded into a InternalError object, and the request status is set to 500.

setResult #

Sets the request result.

Arguments #

Copied to clipboard!
setResult(result, [options]);

Arguments Type Description
result * KuzzleRequest result
options optional, object Optional result configuration

options #

The options object can contain the following properties:

Properties Type (default) Description
headers object Network specific headers. Shortcut to the response header functions
raw boolean (false) If true, instead of a standard kuzzle response, the result is sent as is to the client, without being interpreted
status integer (200) KuzzleRequest status