fix: update JSDoc to match documentation (#294)

* update JSDoc to match documentation @oliverlloyd has mentioned this is the proper way * fix example
guardian · Nov 5, 2021 · d494fe6 · d494fe6
1 parent 1deedc6
commit d494fe6
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/src/coreWebVitals.README.md b/src/coreWebVitals.README.md
@@ -17,7 +17,7 @@ import { initCoreWebVitals, getCookie } from '@guardian/libs';
 // browserId & pageViewId are needed to join up the data downstream.
 const init: InitCoreWebVitalsOptions = {
     browserId : getCookie({ name: 'bwid', shouldMemoize: true}),
-    pageViewId: guardian.ophan.config.pageViewId,
+    pageViewId: guardian.config.ophan.pageViewId,
 
     // Whether to use CODE or PROD endpoints.
     isDev: window.location.hostname !== 'www.theguardian.com',

diff --git a/src/coreWebVitals.ts b/src/coreWebVitals.ts
@@ -145,7 +145,7 @@ export const bypassCoreWebVitalsSampling = (team?: TeamName): void => {
  * @param 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.ophan.pageViewId`. 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`.
  *