requires-port 's direct dependencies. Data on all dependencies, including transitive ones, is available via CSV download.| Name | Version | Size | License | Type | Vulnerabilities |
|---|
"requires-port" is a useful npm package built by unshift. The purpose of this package is to check if a specific protocol necessitates the inclusion of a particular port number in an URL. This feature is crucial in many instances where unique port specifications are required for different protocols. The package supports several protocols, including http, https, ws, wss, ftp, gopher and file.
To use the "requires-port" package in your project, start by installing it. This package is designed for use with browserify or Node.js, and you can find it in the public npm registry. You can install it directly from your command-line interface with the command npm install --save requires-port.
The module exports itself as a function and needs two arguments: the port number and the protocol. The port number can be either a string or a number, and the protocol can be http, http: or even an entire URL like https://yomoma.com. The method will simply split the input at the colon and use the initial result.
Below is an example of how to implement "requires-port" in your code:
'use strict';
var required = require('requires-port');
console.log(required('8080', 'http')) // Output is true
console.log(required('80', 'http')) // Output is false
In this example, the function checks whether the 'http' protocol requires the specified ports '8080' and '80'. The outputs 'true' and 'false' indicate whether or not the ports are required.
You can find the complete and up-to-date documentation for the "requires-port" package on the official GitHub page requires-port GitHub page. This is the best place to get familiarized with the package, understand its functionality in detail, and stay updated on the latest changes and improvements made by the package maintainers. Whether you are a seasoned developer or a newbie, the advanced yet straightforward documentation will guide you through the ins and outs of the "requires-port" package.
