https-service

A wrapper around the node https request method.

Version 2.1.2

1. Installation

$ npm install --save https-service

2. Usage

const HttpsService = require('https-service');

const service = new HttpsService('httpbin.org');

service.get('/get').then(response => {
  console.log(response.data);
});

3. API

The package exports the HttpsService class. This class provides the request method and various convenience methods that call the request method. The request method can be overridden in a subclass. One reason, for example, is adding header values. Be sure to call super.request(...) when overriding this method.

3.1 constructor

HttpsService(hostname);

Creates a new HttpsService instance for the specified host. The hostname can also be a complete URI if the port is not the default HTTPS port number (443). In that case, the scheme must be specified and it must be https.

Examples:

const service = new HttpsService('example.com');

const service = new HttpsService('https://example.com:9000');

3.2 request

service.request(method, path, headers, data);

Sends an HTTPS request to the host specified in the constructor.

The method should be one of GET, HEAD, OPTIONS, TRACE, POST, PUT, PATCH or DELETE. The method is converted to upper case.
The path identifies the resource with respect to the host specified in the constructor.
The headers must be an object or null.
The data specifies the message body and can be a Buffer, a string, or an object. If the data parameter is an object, then it is processed as follows:
- If the Content-Type header is application/json, then the data is serialized by calling JSON.stringify.
- If the Content-Type header is application/x-www-form-urlencoded, then the data is serialized by calling querystring.stringify.
- If the Content-Type header is not set, then the data is serialized by calling JSON.stringify and the Content-Type header is set to application/json.

Returns a promise that is resolved with an object having the following properties:

code - the status code (e.g., 200)
headers - a headers object
type - the content-type header without parameters (e.g., text/html; charset=utf-8 becomes text/html)
data - the received data

The data will be a string if the type begins with text or ends with +xml. It will be an object if the type is application/json. Otherwise, the data will be a Buffer. Note that if the code is 204 (No Content), then the type and data will both be null. Also, if the method is HEAD, then the data will be null.

3.3 get, head

service.get(path [, query])
service.head(path [, query])

Convenience methods for GET and HEAD requests. If the optional query object is specified, it is serialized and appended to the path preceded by a ?. If the path already contains a query, then it is appended with a &.

3.4 post, put, patch

service.post(path, data [, type]);
service.put(path, data [, type]);
service.patch(path, data [, type]);

Convenience methods for the POST, PUT, and PATCH requests.

3.5 delete

service.delete(path);

Convenience method for the DELETE request.

3.6 Media Types

There are three static media type constants on the HttpsService class:

HttpsService.JSON_MEDIA_TYPE = 'application/json';
HttpsService.FORM_MEDIA_TYPE = 'application/x-www-form-urlencoded';

4. License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

fhellwig/https-service