Skip to content

Conversation

@amitsingh05667
Copy link
Contributor

@amitsingh05667 amitsingh05667 commented Oct 3, 2025


📝 Add CAPTCHA parameter docs to signup methods
Fixes: #1471

Changes

  • ✍️ Added @param {String} [options.captcha] to:

    • DBConnection.prototype.signup() (db-connection.js)
    • WebAuth.prototype.signup() (index.js)

Why?

  • 🧩 CAPTCHA field missing in JSDoc caused confusion and TS errors

Testing ✅

  • JSDoc generated correctly
  • Signup works with captcha param
  • No breaking changes
  • npm run build & npm run jsdocs successful

Notes

  • 🔧 TypeScript support pending in DefinitelyTyped
  • 🛠️ Auth0 API already supports captcha
  • 🧾 Doc-only change — no runtime impact

Checklist
✅ JSDoc added
✅ Tested with sample app
✅ Docs & build pass
☑️ Follow-up for TS types (DefinitelyTyped)


@amitsingh05667 amitsingh05667 requested a review from a team as a code owner October 3, 2025 05:06
@amitsingh05667 amitsingh05667 changed the title Fix/1471 missing captcha field in dbsignupoptions docs(core): fix missing captcha param in signup method jsdoc #1471 Oct 3, 2025
@amitsingh05667 amitsingh05667 merged commit 60b4e32 into master Oct 3, 2025
13 checks passed
@amitsingh05667 amitsingh05667 deleted the fix/1471-missing-captcha-field-in-dbsignupoptions branch October 3, 2025 13:46
@auth0 auth0 deleted a comment from subhankarmaiti Oct 3, 2025
@amitsingh05667 amitsingh05667 mentioned this pull request Oct 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

captcha Field Missing in DbSignUpOptions Typing in [email protected]

3 participants