Skip to content

🎨 Palette: JSDoc DX Improvements #798

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
google-labs-jules wants to merge 1 commit into from
Closed

🎨 Palette: JSDoc DX Improvements #798

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/palette-ux-improvement.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"node-version": patch
---

Improve JSDoc for version and EOL_DATES exports to enhance Developer Experience (DX).
17 changes: 16 additions & 1 deletion src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ export type { NodeVersion };

/**
* End-of-Life dates for Node.js major versions.
* Keys are major version strings (e.g. "18"), values are "YYYY-MM-DD" date strings.
* @see https://github.com/nodejs/release#release-schedule
*/
export const EOL_DATES: Record<string, string> = {
"18": "2025-04-30",
Expand Down Expand Up @@ -113,6 +115,19 @@ export const getVersion = (): NodeVersion => {
};

/**
* Node version information.
* Node version information for the current process.
*
* @example
* import { version } from 'node-version';
*
* console.log(version.original); // 'v20.10.0'
*
* if (version.isLTS) {
* console.log(`Running on LTS: ${version.ltsName}`);
* }
*
* if (version.isAtLeast('20.0.0')) {
* // Use new features
* }
*/
export const version: NodeVersion = getVersion();