diff options
Diffstat (limited to 'school/node_modules/requires-port/README.md')
| -rw-r--r-- | school/node_modules/requires-port/README.md | 47 |
1 files changed, 0 insertions, 47 deletions
diff --git a/school/node_modules/requires-port/README.md b/school/node_modules/requires-port/README.md deleted file mode 100644 index 3effe75..0000000 --- a/school/node_modules/requires-port/README.md +++ /dev/null @@ -1,47 +0,0 @@ -# requires-port - -[](http://unshift.io)[](http://browsenpm.org/package/requires-port)[](https://travis-ci.org/unshiftio/requires-port)[](https://david-dm.org/unshiftio/requires-port)[](https://coveralls.io/r/unshiftio/requires-port?branch=master)[](http://webchat.freenode.net/?channels=unshift) - -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: - -```j -npm install --save requires-port -``` - -## Usage - -The module exports it self as function and requires 2 arguments: - -1. The port number, can be a string or number. -2. 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. - -```js -'use strict'; - -var required = require('requires-port'); - -console.log(required('8080', 'http')) // true -console.log(required('80', 'http')) // false -``` - -# License - -MIT |