Skip to content

feat: pin Node.js 20, update contribution docs, add JSDoc examples, a… - #565

Merged
BigBen-7 merged 1 commit into
Lead-Studios:mainfrom
PeterOche:chore/pin-node-js
Aug 29, 2026
Merged

feat: pin Node.js 20, update contribution docs, add JSDoc examples, a…#565
BigBen-7 merged 1 commit into
Lead-Studios:mainfrom
PeterOche:chore/pin-node-js

Conversation

@PeterOche

Copy link
Copy Markdown
Contributor

Description

This PR pins the Node.js version and adds comprehensive JSDoc @example documentation across multiple modules (TokenModule, RecurringModule, EscrowModule) to improve developer experience and IDE auto-completions.

Key Changes:

  • Node.js pinning:
    • Added .nvmrc with version 20.
    • Updated CONTRIBUTING.md to instruct running nvm use prior to npm ci.
    • Added Node.js version badge to README.md.
  • TokenModule:
    • Added JSDoc @example code snippets to all read methods (balance, balanceOfBatch, allowance, name, symbol, decimals, totalSupply, totalHolders, getHolders, isFrozen).
  • RecurringModule:
    • Added JSDoc @example blocks and lifecycle implementations for all methods (getRecurring, setup, execute, cancel, pauseRecurring, resumeRecurring, amendRecurring, transferPayer, getRecurringByPayer, getRecurringByPayee, isExecutable, executeAllDue, cancelBatch, getExecutionSchedule, getRecurringHistory).
  • EscrowModule:
    • Added JSDoc @example blocks for read methods (getEscrow, getEscrowStats, getEscrowsByDepositor, getEscrowsByBeneficiary, escrowBetween, getEscrowedValueForDepositor, getEscrowsBatch, isSettled, isExpired, getEscrowAge).
  • Changelog:
    • Updated CHANGELOG.md under [Unreleased] with descriptions for all changes.

Closes #509
Closes #512
Closes #513
Closes #515

@drips-wave

drips-wave Bot commented Aug 29, 2026

Copy link
Copy Markdown

@PeterOche Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@BigBen-7
BigBen-7 merged commit bf9b4b2 into Lead-Studios:main Aug 29, 2026
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

2 participants