Skip to content

docs(index.js): add JSDoc comments to delay functions#59

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

docs(index.js): add JSDoc comments to delay functions#59
theluckystrike wants to merge 1 commit intosindresorhus:mainfrom
theluckystrike:docs/jsdoc-additions

Conversation

@theluckystrike
Copy link

What

Adds comprehensive JSDoc documentation to the delay module.

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 createDelay function with @param descriptions
  • Added JSDoc to default delay function with @param, @returns, and @example
  • Added JSDoc to rangeDelay function with @param descriptions
  • Added JSDoc to clearDelay function with @param description

Testing

  • All 9 existing tests pass ✅

- Add module-level documentation
- Add JSDoc to createDelay function
- Add JSDoc to default delay function with @example
- Add JSDoc to rangeDelay function
- Add JSDoc to clearDelay function
@sindresorhus
Copy link
Owner

There is already an index.d.ts. And please don't spam with AI PRs.

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