Package Health Score

77 / 100

security
No known security issues
popularity
Influential project
maintenance
Sustainable
community
Sustainable

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
3.1.2	\|	01/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.0.3	\|	09/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.6.1	\|	08/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.0	\|	11/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.0	\|	06/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Influential project

Weekly Downloads (1,630,791)

GitHub Stars: 256
Forks: 13
Contributors: 20

Direct Usage Popularity

The npm package get-port-please receives a total of 1,630,791 downloads a week. As such, we scored get-port-please popularity level to be Influential project.

Based on project statistics from the GitHub repository for the npm package get-port-please, we found that it has been starred 256 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the get-port-please repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like get-port-please is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 3
Open PR: 7
Last Release: 11 months ago
Last Commit: 7 months ago

Further analysis of the maintenance status of get-port-please based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that get-port-please demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 4 years
Dependencies: 0 Direct
Versions: 22
Install Size: 24.6 kB
Dist-tags: 1
# of Files: 8
Maintainers: 1
TS Typings: Yes

get-port-please has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

🔌 get-port-please

Get an available TCP port to listen

Usage

Install package:

npm i get-port-please

// ESM
import {
  getPort,
  checkPort,
  getRandomPort,
  waitForPort,
} from "get-port-please";

// CommonJS
const {
  getPort,
  checkPort,
  getRandomPort,
  waitForPort,
} = require("get-port-please");

getPort(options?: GetPortOptions): Promise
checkPort(port: number, host?: string): Promise
waitForPort(port: number, options): Promise

Try sequence is: port > ports > random

Options

interface GetPortOptions {
  name?: string;

  random?: boolean;
  port?: number;
  portRange?: [fromInclusive: number, toInclusive: number];
  ports?: number[];
  host?: string;

  memoDir?: string;
  memoName?: string;
}

`name`

Unique name for port memorizing. Default is default.

`random`

If enabled, port and ports will be ignored. Default is false.

`port`

First port to check. Default is process.env.PORT || 3000

`ports`

Extended ports to check.

`portRange`

Extended port range to check.

The range's start and end are inclusive, i.e. it is [start, end] in the mathematical notion. Reversed port ranges are not supported. If start > end, then an empty range will be returned.

`alternativePortRange`

Alternative port range to check as fallback when none of the ports are available.

The range's start and end are inclusive, i.e. it is [start, end] in the mathematical notion. Reversed port ranges are not supported. If start > end, then an empty range will be returned.

The default range is [3000, 3100] (only when port is unspecified).

`host`

The host to check. Default is process.env.HOST otherwise all available hosts will be checked.

License

MIT

get-port-please development dependencies

@types/node @vitest/coverage-v8 changelogen eslint eslint-config-unjs jiti prettier typescript unbuild vitest

FAQs

What is get-port-please?

Get an available TCP port to listen. Visit Snyk Advisor to see a full health score report for get-port-please, including popularity, security, maintenance & community analysis.

Is get-port-please popular?

The npm package get-port-please receives a total of 1,630,791 weekly downloads. As such, get-port-please popularity was classified as an influential project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is get-port-please well maintained?

We found indications that get-port-please maintenance is sustainable demonstrating some project activity. We saw a total of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is get-port-please safe to use?

The npm package get-port-please was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 20 November-2024, at 17:29 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (1,630,791)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

🔌 get-port-please

Usage

Options

name

random

port

ports

portRange

alternativePortRange

host

License

get-port-please development dependencies

FAQs

What is get-port-please?

Is get-port-please popular?

Is get-port-please well maintained?

Is get-port-please safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

`name`

`random`

`port`

`ports`

`portRange`

`alternativePortRange`

`host`