History

Kate Temkin c893a86e54 initial commit of template		2024-04-26 22:49:34 -06:00
..
.npmignore	initial commit of template	2024-04-26 22:49:34 -06:00
.travis.yml	initial commit of template	2024-04-26 22:49:34 -06:00
index.js	initial commit of template	2024-04-26 22:49:34 -06:00
LICENSE	initial commit of template	2024-04-26 22:49:34 -06:00
package.json	initial commit of template	2024-04-26 22:49:34 -06:00
README.md	initial commit of template	2024-04-26 22:49:34 -06:00
test.js	initial commit of template	2024-04-26 22:49:34 -06:00

README.md

requires-port

The module name says it all, check if a protocol requires a given port.

Installation

This module is intended to be used with browserify or Node.js and is distributed in the public npm registry. To install it simply run the following command from your CLI:

npm install --save requires-port

Usage

The module exports it self as function and requires 2 arguments:

The port number, can be a string or number.
Protocol, can be http, http: or even https://yomoma.com. We just split it at : and use the first result. We currently accept the following protocols:
- http
- https
- ws
- wss
- ftp
- gopher
- file

It returns a boolean that indicates if protocol requires this port to be added to your URL.

'use strict';

var required = require('requires-port');

console.log(required('8080', 'http')) // true
console.log(required('80', 'http'))   // false

License

MIT