Fix compiler “An argument for 'config' was not provided”

alphagov · Nov 8, 2022 · 5529e24 · 5529e24
1 parent 65485cc
commit 5529e24
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 7 deletions.
diff --git a/src/govuk/components/accordion/accordion.mjs b/src/govuk/components/accordion/accordion.mjs
@@ -31,7 +31,7 @@ var TRANSLATIONS_DEFAULT = {
  *
  * @class
  * @param {HTMLElement} $module - HTML element to use for accordion
- * @param {object} config - Accordion config
+ * @param {object} [config] - Accordion config
  * @param {AccordionTranslations} config.i18n - Translations
  */
 function Accordion ($module, config) {

diff --git a/src/govuk/components/button/button.mjs b/src/govuk/components/button/button.mjs
@@ -11,7 +11,7 @@ var DEBOUNCE_TIMEOUT_IN_SECONDS = 1
  *
  * @class
  * @param {HTMLElement} $module - The element this component controls
- * @param {object} config - Button config
+ * @param {object} [config] - Button config
  * @param {boolean} [config.preventDoubleClick=false] - Whether the button should prevent double clicks
  */
 function Button ($module, config) {

diff --git a/src/govuk/components/character-count/character-count.mjs b/src/govuk/components/character-count/character-count.mjs
@@ -48,7 +48,7 @@ var TRANSLATIONS_DEFAULT = {
  *
  * @class
  * @param {HTMLElement} $module - The element this component controls
- * @param {object} config - Character count config
+ * @param {object} [config] - Character count config
  * @param {number} config.maxlength - If `maxwords` is set, this is not required.
  * The maximum number of characters. If `maxwords` is provided, it will be ignored.
  * @param {number} config.maxwords - If `maxlength` is set, this is not required.

diff --git a/src/govuk/components/character-count/character-count.unit.test.mjs b/src/govuk/components/character-count/character-count.unit.test.mjs
@@ -101,7 +101,9 @@ describe('CharacterCount', () => {
 
             const component = new CharacterCount($div, {
               i18n: {
-                charactersUnderLimitOne: 'Different custom text. Count: %{count}'
+                charactersUnderLimit: {
+                  one: 'Different custom text. Count: %{count}'
+                }
               }
             })
             expect(component.formatCountMessage(1, 'characters')).toEqual('Custom text. Count: 1')

diff --git a/src/govuk/components/error-summary/error-summary.mjs b/src/govuk/components/error-summary/error-summary.mjs
@@ -12,7 +12,7 @@ import { normaliseDataset } from '../../common/normalise-dataset.mjs'
  *
  * @class
  * @param {HTMLElement} $module - The element this component controls
- * @param {object} config - Error summary config
+ * @param {object} [config] - Error summary config
  * @param {boolean} [config.disableAutoFocus=false] - Whether to disable the component taking focus on initialisation
  */
 function ErrorSummary ($module, config) {

diff --git a/src/govuk/components/notification-banner/notification-banner.mjs b/src/govuk/components/notification-banner/notification-banner.mjs
@@ -8,7 +8,7 @@ import { normaliseDataset } from '../../common/normalise-dataset.mjs'
  *
  * @class
  * @param {HTMLElement} $module - HTML element to use for notification banner
- * @param {object} config - Error summary config
+ * @param {object} [config] - Error summary config
  * @param {boolean} [config.disableAutoFocus=false] - Whether to disable the component taking focus on initialisation
  */
 function NotificationBanner ($module, config) {

diff --git a/src/govuk/i18n.mjs b/src/govuk/i18n.mjs
@@ -5,7 +5,7 @@
  * @class
  * @private
  * @param {object} translations - Key-value pairs of the translation strings to use.
- * @param {object} config - Configuration options for the function.
+ * @param {object} [config] - Configuration options for the function.
  * @param {string} config.locale - An overriding locale for the PluralRules functionality.
  */
 export function I18n (translations, config) {