docs: fix JSDoc for initCoreWebVitals

guardian · Mar 22, 2022 · fa648c0 · fa648c0
1 parent f2122d2
commit fa648c0
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/src/coreWebVitals/index.ts b/src/coreWebVitals/index.ts
@@ -118,14 +118,14 @@ type InitCoreWebVitalsOptions = {
 /**
  * Initialise sending Core Web Vitals metrics to a logging endpoint.
  *
- * @param init - the initialisation options
+ * @param {InitCoreWebVitalsOptions} init - the initialisation options
  * @param init.isDev - used to determine whether to use CODE or PROD endpoints.
  * @param init.browserId - identifies the browser. Usually available via `getCookie({ name: 'bwid' })`. Defaults to `null`
  * @param init.pageViewId - identifies the page view. Usually available on `guardian.config.ophan.pageViewId`. Defaults to `null`
  *
  * @param init.sampling - sampling rate for sending data. Defaults to `0.01`.
  *
- * @param team - Optional team to trigger a log event once metrics are queued.
+ * @param init.team - Optional team to trigger a log event once metrics are queued.
  */
 export const initCoreWebVitals = async ({
 	browserId = null,