# https-service-legacy

> A wrapper around the node https request method.

Latest version **1.0.6** (published 2017-11-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install https-service-legacy
pnpm add https-service-legacy
yarn add https-service-legacy
bun add https-service-legacy
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2017-11-20 |
| First published | 2017-11-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Frank Hellwig |
| Maintainers | _platekun |
| Keywords | https, service |

## Links

- npm: https://www.npmjs.com/package/https-service-legacy
- Repository: https://github.com/Platekun/https-service
- Homepage: https://github.com/Platekun/https-service#README.md
- Issues: https://github.com/fhellwig/https-service/issues
- npm.io page: https://npm.io/package/https-service-legacy

## Dependencies (1)

- [https-error-legacy](https://npm.io/package/https-error-legacy.md) ^1.0.2

## Recent versions

- 1.0.6 (latest) — 2017-11-20

## README

# https-service

A wrapper around the node https request method.

Version 1.0.6

## 1. Installation

```bash
$ npm install --save https-service-legacy
```

## 2. Usage

```javascript
var HttpsService = require('https-service-legacy');

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

service.get('/get', (err, body) => {
    console.log(body);
}
```

## 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

```javascript
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:**

```javascript
var service = new HttpsService('example.com');
```

```javascript
var service = new HttpsService('https://example.com:9000');
```

### 3.2 request

```javascript
service.request(method, path, headers, data, callback)
```

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`.
- The `callback` is called upon completion of the request. On error, it is called as `callback(err)`. On success, it is called as `callback(null, data, type, headers)`.
    - The `data` is the response message body. It 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`.
    - The `type` is the value of the `Content-Type` header with all parameters removed. For example, if the `Content-Type` is `text/html; charset=utf-8`, then the `type` argument in the callback will simply be `text/html`.
    - The `headers` are the full, unmodified headers from the response.

### 3.3 get, head

```javascript
service.get(path, [query,] callback)
service.head(path, [query,] callback)
```

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

```javascript
service.post(path, data, callback)
service.put(path, data, callback)
service.patch(path, data, callback)
```

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

### 3.5 delete

```javascript
service.delete(path, callback)
```

Convenience method for the `DELETE` request.

### 3.6 Media Types

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

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

## 4. License

The MIT License (MIT)

Copyright (c) 2016 Frank Hellwig

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.

---
_Source: https://npm.io/package/https-service-legacy · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._