Skip to content

Commit

Permalink
Have Babel ignore JSDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
domoscargin committed Oct 19, 2023
1 parent 2398058 commit c2a9751
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions packages/govuk-frontend/src/govuk/errors/index.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -48,16 +48,19 @@ export class ElementError extends GOVUKFrontendError {
name = 'ElementError'

/**
* @internal
* @overload
* @param {string} message - Element error message
*/

/**
* @internal
* @overload
* @param {ElementErrorOptions} options - Element error options
*/

/**
* @internal
* @param {string | ElementErrorOptions} messageOrOptions - Element error message or options
*/
constructor(messageOrOptions) {
Expand All @@ -84,6 +87,7 @@ export class ElementError extends GOVUKFrontendError {
/**
* Element error options
*
* @internal
* @typedef {object} ElementErrorOptions
* @property {string} componentName - The name of the component throwing the error
* @property {string} identifier - An identifier that'll let the user understand which element has an error. This is whatever makes the most sense
Expand Down

0 comments on commit c2a9751

Please sign in to comment.