From 5d85080aa6a42343c60cf76b53c9fb34c6c3201e Mon Sep 17 00:00:00 2001 From: Brett Kyle Date: Thu, 19 Oct 2023 15:59:16 +0100 Subject: [PATCH] Have Babel ignore JSDoc --- packages/govuk-frontend/src/govuk/errors/index.mjs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/packages/govuk-frontend/src/govuk/errors/index.mjs b/packages/govuk-frontend/src/govuk/errors/index.mjs index d2de5237d9..c8a1b42d1f 100644 --- a/packages/govuk-frontend/src/govuk/errors/index.mjs +++ b/packages/govuk-frontend/src/govuk/errors/index.mjs @@ -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) { @@ -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