method-shorthand-jsdoc

What problem does it solve?

When factory functions expose helpers that are only used by returned methods, JSDoc can be lost or not shown in IDE hover. This skill teaches moving internal helpers into the return object using method shorthand so documentation stays attached to the correct methods.

Core Features & Use Cases

• Use method shorthand to expose internal helpers as methods on the returned object, ensuring JSDoc remains visible to consumers.
• Supports scenarios where helper functions are only invoked by sibling methods and need to reference each other via this.
• Applicable to JavaScript/TypeScript factory patterns to improve code readability and developer experience.

Quick Start

Identify a factory function with internal helpers and refactor by placing the helpers into the returned object using method shorthand to preserve inline documentation.