api.service.LocalClientRequest

This service implements a class for sending requests to the local instance of Hitchy without using network communications or the HTTP protocol. Because of that, requests are processed much faster.

The service is inheriting from PassThrough and requires the request's payload/body to be streamed.

Example

There is an example included with the description of api.Client which is exposing this service using a shorter reference for convenience.

Constructor

An object with common request properties method, url and headers is accepted as argument on constructing the request:

const request = new api.service.LocalClientRequest( {
    method: "DELETE",
    url: "/api/my-model/123",
    headers: {
		"content-type": "application/json",
    },
} );

Because requests are always sent to the local instance, the URL may consist of a path and an optional query, only.

Properties

internal

This property is provided to distinguish local-only requests from requests potentially communicating with remote services. It is always true.

Due to immediately using this request instance for dispatching it locally, this property is available to some invoked request handler, too. Those may check this property to handle internal requests differently e.g. by reducing necessary authentication or similar.

method

This property exposes the request's HTTP method as selected on constructing the request. It is used by Hitchy's routing capabilities to pick routes for handling the request.

headers

This property exposes the request's headers with all names converted to lowercase.

response

An instance of LocalClientResponse is created and exposed here. It is used to manage the response to the dispatched request.

url

This property exposes the URL provided on constructing the request.

Methods

dispatch()

This method must be invoked to eventually "send" the request so that the local Hitchy instance is dispatching it using its Router.

It returns a promise resolved once the request has been fully handled by the instance. It is delivering the response object created by the request and exposed as its property.

const response = await request.dispatch();

if ( response.statusCode === 200 ) {
    const body = await response.body();
	const data = JSON.parse( body.toString( "utf8" ) );

    // TODO: process response
}