Skip to content

docs(index.js): add JSDoc comments to ElectronStore class#301

Closed
theluckystrike wants to merge 1 commit intosindresorhus:mainfrom
theluckystrike:docs/jsdoc-additions
Closed

docs(index.js): add JSDoc comments to ElectronStore class#301
theluckystrike wants to merge 1 commit intosindresorhus:mainfrom
theluckystrike:docs/jsdoc-additions

Conversation

@theluckystrike
Copy link

What

Adds comprehensive JSDoc documentation comments to the ElectronStore class and related functions in index.js.

Why

Improves developer experience by providing clear documentation for the API surface. JSDoc comments help IDEs provide autocomplete and make the codebase more maintainable.

How

  • Added module-level @module documentation
  • Added JSDoc to initDataListener function explaining its purpose and return type
  • Added JSDoc to ElectronStore constructor with @param descriptions
  • Added JSDoc to initRenderer static method
  • Added JSDoc to openInEditor method with @returns description

Testing

  • All existing tests pass

- Add module documentation
- Add JSDoc to initDataListener function
- Add JSDoc to ElectronStore class constructor
- Add JSDoc to initRenderer static method
- Add JSDoc to openInEditor method
Repository owner locked and limited conversation to collaborators Mar 3, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants