npmpackage.info

Gathering detailed insights and metrics for get-port-please

Other packages similar to get-port-please

get-port

7.1.0

Get an available port

wait-port

1.1.0

Utility to wait for a TCP port to open.

listhen

1.9.0

👂 Elegant HTTP Listener

get-pkg-repo

5.0.0

Get repository user and project information from package.json file contents.

Gathering detailed insights and metrics for get-port-please

get-port-please

🔌 Get an available open port

3.1.2

259

MIT

TypeScript

149,654,370 3

Installations

npm install get-port-please

Pull Requests

Open

9

Total

93

Closed

14

Merged

70

Issues

Open

3

Total

12

Closed

9

Releases

v3.1.2

Published on 09 Jan 2024

v3.1.1

Published on 06 Sept 2023

v3.1.0

Published on 06 Sept 2023

View all 3 releases

Developer

unjs

Developer Guide

BETA

Module System

CommonJS, ESM

Min. Node Version

Typescript Support

Yes

Node Version

20.10.0

NPM Version

10.2.3 Statistics

259 Stars

157 Commits

14 Forks

4 Watching

7 Branches

22 Contributors

Updated on 27 Nov 2024

Languages

TypeScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

149,654,370

Last day

0.7%

325,415

Compared to previous day

Last week

3.8%

1,693,461

Compared to previous week

Last month

6.9%

7,209,200

Compared to previous month

Last year

107.1%

72,609,598

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

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

Versions

🔌 get-port-please

Get an available TCP port to listen

Usage

Install package:

1npm i get-port-please

1// ESM
2import {
3  getPort,
4  checkPort,
5  getRandomPort,
6  waitForPort,
7} from "get-port-please";
8
9// CommonJS
10const {
11  getPort,
12  checkPort,
13  getRandomPort,
14  waitForPort,
15} = require("get-port-please");

1getPort(options?: GetPortOptions): Promise<number>
2checkPort(port: number, host?: string): Promise<number | false>
3waitForPort(port: number, options): Promise<number | false>

Try sequence is: port > ports > random

Options

1interface GetPortOptions {
2  name?: string;
3
4  random?: boolean;
5  port?: number;
6  portRange?: [fromInclusive: number, toInclusive: number];
7  ports?: number[];
8  host?: string;
9
10  memoDir?: string;
11  memoName?: string;
12}

`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

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

1

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

Score

3

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More