Skip to content

Commit 2ffb384

Browse files
committed
add type column
1 parent d74269f commit 2ffb384

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -226,24 +226,24 @@ amplitude.init('YOUR_API_KEY_HERE', null, {
226226
});
227227
```
228228

229-
| option | description | default |
230-
|------------|----------------------------------------------------------------------------------|-----------|
231-
| batchEvents | If `true`, events are batched together and uploaded only when the number of unsent events is greater than or equal to `eventUploadThreshold` or after `eventUploadPeriodMillis` milliseconds have passed since the first unsent event was logged. | `false` |
232-
| cookieExpiration | The number of days after which the Amplitude cookie will expire | 365\*10 (10 years) |
233-
| cookieName | Custom name for the Amplitude cookie | 'amplitude_id' |
234-
| deviceId | Custom device ID to set. Note this is not recommended unless you really know what you are doing (like if you have your own system for tracking user devices) | Randomly generated UUID |
235-
| domain | Custom cookie domain | The top domain of the current page's url |
236-
| eventUploadPeriodMillis | Amount of time in milliseconds that the SDK waits before uploading events if `batchEvents` is `true`. | 30\*1000 (30 sec) |
237-
| eventUploadThreshold | Minimum number of events to batch together per request if `batchEvents` is `true`. | 30 |
238-
| includeReferrer | If `true`, captures the `referrer` and `referring_domain` for each session, as well as the user's `initial_referrer` and `initial_referring_domain` via a set once operation. | `false` |
239-
| includeUtm | If `true`, finds utm parameters in the query string or the __utmz cookie, parses, and includes them as user propeties on all events uploaded. | `false` |
240-
| language | Custom language to set | Language determined by browser |
241-
| optOut | Whether to disable tracking for the current user | `false` |
242-
| platform | Custom platform to set | 'Web' |
243-
| saveEvents | If `true`, saves events to localStorage and removes them upon successful upload.<br><i>NOTE:</i> Without saving events, events may be lost if the user navigates to another page before events are uploaded. | `true` |
244-
| savedMaxCount | Maximum number of events to save in localStorage. If more events are logged while offline, old events are removed. | 1000 |
245-
| sessionTimeout | Time between logged events before a new session starts in milliseconds | 30\*60\*1000 (30 min) |
246-
| uploadBatchSize | Maximum number of events to send to the server per request. | 100 |
229+
| option | type | description | default |
230+
|------------|----------|------------------------------------------------------------------------|-----------|
231+
| batchEvents | boolean | If `true`, events are batched together and uploaded only when the number of unsent events is greater than or equal to `eventUploadThreshold` or after `eventUploadPeriodMillis` milliseconds have passed since the first unsent event was logged. | `false` |
232+
| cookieExpiration | number | The number of days after which the Amplitude cookie will expire | 365\*10 (10 years) |
233+
| cookieName | string | Custom name for the Amplitude cookie | 'amplitude_id' |
234+
| deviceId | string | Custom device ID to set. Note this is not recommended unless you really know what you are doing (like if you have your own system for tracking user devices) | Randomly generated UUID |
235+
| domain | string | Custom cookie domain | The top domain of the current page's url |
236+
| eventUploadPeriodMillis | number | Amount of time in milliseconds that the SDK waits before uploading events if `batchEvents` is `true`. | 30\*1000 (30 sec) |
237+
| eventUploadThreshold | number | Minimum number of events to batch together per request if `batchEvents` is `true`. | 30 |
238+
| includeReferrer | boolean | If `true`, captures the `referrer` and `referring_domain` for each session, as well as the user's `initial_referrer` and `initial_referring_domain` via a set once operation. | `false` |
239+
| includeUtm | boolean | If `true`, finds utm parameters in the query string or the __utmz cookie, parses, and includes them as user propeties on all events uploaded. | `false` |
240+
| language | string | Custom language to set | Language determined by browser |
241+
| optOut | boolean | Whether to disable tracking for the current user | `false` |
242+
| platform | string | Custom platform to set | 'Web' |
243+
| saveEvents | boolean | If `true`, saves events to localStorage and removes them upon successful upload.<br><i>NOTE:</i> Without saving events, events may be lost if the user navigates to another page before events are uploaded. | `true` |
244+
| savedMaxCount | number | Maximum number of events to save in localStorage. If more events are logged while offline, old events are removed. | 1000 |
245+
| sessionTimeout | number | Time between logged events before a new session starts in milliseconds | 30\*60\*1000 (30 min) |
246+
| uploadBatchSize | number | Maximum number of events to send to the server per request. | 100 |
247247

248248
# Advanced #
249249
This SDK automatically grabs useful data about the browser, including browser type and operating system version.

0 commit comments

Comments
 (0)