fix(docs): document error() option for renderCaptcha()

[pmalouin]

Changes

The WebAuth.renderCaptcha(element, options, callback) and WebAuth.renderPasswordlessCaptcha(element, options, callback) methods accept an option to override the error message rendered when an error is returned while fetching the bot detection challenge. It can be used like this:

var webAuth = new auth0.WebAuth(params);
var options = {
  templates: {
    error: function(err) {
      return '<div class="error" style="color: red;">This is a custom error message...</div>';
    }
  }
};
var captcha = webAuth.renderCaptcha(
  document.querySelector('.captcha-container'),
  options
);

In this PR, I am adding jsdocs for these attributes, to document this option in our generated docs at https://auth0.github.io/auth0.js/WebAuth.html#renderCaptcha

References

Please include relevant links supporting this change such as a:

• support ticket
• community post
• StackOverflow post
• support forum thread

Testing

Please describe how this can be tested by reviewers. Be specific about anything not tested and reasons why. If this library has unit and/or integration testing, tests should be added for new functionality and existing tests should complete without errors.

• This change adds unit test coverage
• This change adds integration test coverage

Checklist

• I have read the Auth0 general contribution guidelines
• I have read the Auth0 Code of Conduct
• All tests and linters described in the Develop section run without errors

[frederikprijck]

The WebAuth.renderCaptcha(element, options, callback) and WebAuth.renderPasswordlessCaptcha(element, options, callback) methods accept an option to override the error message rendered when an error is returned while fetching the bot detection challenge. It can be used like this:

This PR does not add docs to those methods, you want to add them here:

• https://github.com/auth0/auth0.js/blob/master/src/web-auth/index.js#L1123
• https://github.com/auth0/auth0.js/blob/master/src/web-auth/index.js#L1143

We can also keep what you have, but to reflect the docs for both WebAuth.renderCaptcha and WebAuth.renderPasswordlessCaptcha we need to ensure we patch the jsdoc for those methods.

[frederikprijck]

Thanks 🎉