https://github.com/shinnn/node-http-s

Returns built-in http or https module accordingly to the protocol name
https://github.com/shinnn/node-http-s

Last synced: 27 days ago
JSON representation

Returns built-in http or https module accordingly to the protocol name

• Host: GitHub
• URL: https://github.com/shinnn/node-http-s
• Owner: shinnn
• License: mit
• Created: 2014-07-15T05:34:48.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-12-29T14:29:06.000Z (almost 10 years ago)
• Last Synced: 2024-10-11T22:26:48.659Z (about 1 month ago)
• Language: JavaScript
• Size: 242 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# http-s 

[![NPM version](https://img.shields.io/npm/v/http-s.svg?style=flat)](https://www.npmjs.com/package/http-s)

[![Bower version](https://img.shields.io/bower/v/http-s.svg?style=flat)](https://github.com/shinnn/node-http-s/releases)

[![Build Status](https://travis-ci.org/shinnn/node-http-s.svg?branch=master)](https://travis-ci.org/shinnn/node-http-s)

[![Build status](https://ci.appveyor.com/api/projects/status/ygrt2hgh5iba4jtt?svg=true)](https://ci.appveyor.com/project/ShinnosukeWatanabe/node-http-s)

[![Coverage Status](https://img.shields.io/coveralls/shinnn/node-http-s.svg?style=flat)](https://coveralls.io/r/shinnn/node-http-s)

[![devDependency Status](https://david-dm.org/shinnn/node-http-s/dev-status.svg)](https://david-dm.org/shinnn/node-http-s#info=devDependencies)

A [Node](http://nodejs.org/) module to load the [http][http] or [https][https] module accordingly to the protocol name

```javascript

var httpOrHttps = require('http-s');

httpOrHttps('http://nodejs.org/'); // equivalent of `require('http')`

httpOrHttps('https://www.npmjs.com/'); // equivalent of `require('https')`

httpOrHttps({protocol: 'http:'}); // equivalent of `require('http')`

```

## Installation

### [npm](https://www.npmjs.com/)

```sh

npm install http-s

```

### [bower](http://bower.io/)

```sh

bower install http-s

```

## API

```javascript

var httpOrHttps = require('http-s');

```

### httpOrHttps(*urlObject*)

*urlObject*: `Object` (which has `protocol` property)  

Return: [http][http] or [https][https]

It returns [http][http] module if the `protocol` property is `"http:"`, or returns [https][https] module if the property is `"https:"`.

```javascript

httpOrHttps({protocol: 'https:'}); //=> https

var url = require('url');

var options = url.parse('http://nodejs.org/api/url.html');

// => {protocol: 'http:', slashes: true, auth: null, ...}

httpOrHttps(options); //=> http

```

### httpOrHttps(*urlString*)

*urlString*: `String`  

Return: [http][http] or [https][https]

When it takes a string as an argument instead of an object, it automatically parses the string with [`url.parse()`](http://nodejs.org/api/url.html#url_url_parse_urlstr_parsequerystring_slashesdenotehost).

```javascript

httpOrHttps('http://nodeschool.io/'); //=> http

```

## License

Copyright (c) 2014 [Shinnosuke Watanabe](https://github.com/shinnn)

Licensed under [the MIT License](./LICENSE).

[http]: http://nodejs.org/api/http.html#http_http

[https]: http://nodejs.org/api/https.html#https_https