method-shorthand-jsdoc

SKILL.md

When factory functions have helper functions that are only used by returned methods, move them INTO the return object using method shorthand. This ensures JSDoc comments are properly passed through to consumers.

When you hover over head.getEpoch() in your IDE, you see... nothing. The JSDoc is lost.

Move the helper INTO the return object using method shorthand:

Move helper functions into return objects using method shorthand for proper JSDoc preservation. Use when factory functions have internal helpers that should expose documentation to consumers, or when hovering over returned methods shows no JSDoc. Source: epicenterhq/epicenter.

View raw