Skip to content

Commit cfd3e4e

Browse files
committed
Update nomenclature. obs » Obs.js
1 parent 6b09705 commit cfd3e4e

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

obs.js

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
;(() => {
22

33
/**
4-
* obs.js uses the Navigator and Battery APIs to get realtime network and
4+
* Obs.js uses the Navigator and Battery APIs to get realtime network and
55
* battery status of your user’s device. You can use this information to
66
* adapt to their context, or send the data off to SpeedCurve with
77
* `obs-speedcurve.js`.
@@ -30,7 +30,7 @@
3030
// Grab the `connection` property from `navigator`.
3131
const { connection } = navigator;
3232

33-
// Store state in a global `obs` object for reuse later in your application.
33+
// Store state in a global `window.obs` object for reuse later in your application.
3434
window.obs = window.obs || {};
3535

3636
const obsConfig = (window.obs && window.obs.config) || {};
@@ -61,12 +61,12 @@
6161
// Combine network capability (RTT + bandwidth) and user/device preferences
6262
// (Save-Data, low battery) into a delivery stance.
6363
//
64-
// Exposes:
65-
// - obs.connectionCapability: 'strong'|'moderate'|'weak'
66-
// - obs.conservationPreference: 'conserve'|'neutral'
67-
// - obs.deliveryMode: 'rich'|'cautious'|'lite'
68-
// - obs.canShowRichMedia: boolean
69-
// - obs.shouldAvoidRichMedia: boolean
64+
// Exposes on `window.obs`:
65+
// - connectionCapability: 'strong'|'moderate'|'weak'
66+
// - conservationPreference: 'conserve'|'neutral'
67+
// - deliveryMode: 'rich'|'cautious'|'lite'
68+
// - canShowRichMedia: boolean
69+
// - shouldAvoidRichMedia: boolean
7070
const recomputeDelivery = () => {
7171
const o = window.obs || {};
7272

0 commit comments

Comments
 (0)