Skip to content
This repository has been archived by the owner on Sep 1, 2022. It is now read-only.

fix: update JSDoc to match documentation #294

Merged
merged 2 commits into from
Nov 5, 2021
Merged

fix: update JSDoc to match documentation #294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
baadc6b
update JSDoc to match documentation
mxdvl Nov 5, 2021
6cfa866
fix example
mxdvl Nov 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/coreWebVitals.README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
2 changes: 1 addition & 1 deletion src/coreWebVitals.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
*
Expand Down