http-party/node-portfinder

Update documentation for `getPort`, `getPorts`, `getSocket`

Open

#170 opened on Mar 12, 2025

View on GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (101 forks)github user discovery
good first issue

Repository metrics

Stars
 (899 stars)
PR merge metrics
 (PR metrics pending)

Description

Update documentation for getPort, getPorts, getSocket

Follow the idea for docs from https://caolan.github.io/async/v3/docs.html#concat

see #168 and #169 for context.

Remove the *Promise based docs and only document getPort, getPorts, getSocket

Great issue for new contributors. Feel free to make a pull request! Don't hesitate to ask if you need help or are confused.

Contributor guide

Research direction
Review the existing documentation for the functions mentioned and update them following the pattern used in the async library's concat documentation. Ensure to remove any *Promise based docs.
Tech stack
javascript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85