Skip to content

docs(openfeature-node-server): adding jsdocs to public interfaces#1433

Merged
joker23 merged 2 commits into
mainfrom
skz/sdk-2213/openfeature-migration-jsdocs
Jun 17, 2026
Merged

docs(openfeature-node-server): adding jsdocs to public interfaces#1433
joker23 merged 2 commits into
mainfrom
skz/sdk-2213/openfeature-migration-jsdocs

Conversation

@joker23

@joker23 joker23 commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Note

Low Risk
Documentation-only changes with no behavioral or API modifications.

Overview
Adds JSDoc across the shared OpenFeature server provider surface so published APIs are documented for consumers and IDEs.

BaseOpenFeatureProvider gains docs on wrongTypeResult, all four resolve*Evaluation methods (including type-mismatch → default behavior), hooks, and getClient(). OpenFeatureLDClientContract documents variationDetail, waitForInitialization, flush, close, and track, including how shutdown hooks relate to the provider lifecycle. translateContext documents the logger parameter on the public export.

No runtime or type changes—comments only.

Reviewed by Cursor Bugbot for commit f4fa289. Bugbot is set up for automated code reviews on this repo. Configure here.

@joker23 joker23 requested a review from a team as a code owner June 8, 2026 19:56
@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

@launchdarkly/js-sdk-common size report
This is the brotli compressed size of the ESM build.
Compressed size: 26365 bytes
Compressed size limit: 29000
Uncompressed size: 129044 bytes

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

@launchdarkly/js-client-sdk-common size report
This is the brotli compressed size of the ESM build.
Compressed size: 38739 bytes
Compressed size limit: 39000
Uncompressed size: 212244 bytes

@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

@launchdarkly/browser size report
This is the brotli compressed size of the ESM build.
Compressed size: 179579 bytes
Compressed size limit: 200000
Uncompressed size: 831422 bytes

@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

@launchdarkly/js-client-sdk size report
This is the brotli compressed size of the ESM build.
Compressed size: 31978 bytes
Compressed size limit: 34000
Uncompressed size: 114243 bytes

@joker23 joker23 force-pushed the skz/sdk-2213/openfeature-migration-jsdocs branch from 8a5905e to 55affae Compare June 15, 2026 14:57
@joker23 joker23 force-pushed the skz/sdk-2213/openfeature-migration-jsdocs branch from 55affae to f4fa289 Compare June 15, 2026 21:24
@joker23 joker23 merged commit 4d93199 into main Jun 17, 2026
50 checks passed
@joker23 joker23 deleted the skz/sdk-2213/openfeature-migration-jsdocs branch June 17, 2026 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants