chore: update segment docs

DavidWells · Dec 6, 2023 · 6f1d7af · 6f1d7af
1 parent 287c5ac
commit 6f1d7af
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -742,7 +742,7 @@ The `analytics` has a robust plugin system. Here is a list of currently availabl
 | **[@analytics/remote-storage-utils](https://github.com/DavidWells/analytics/tree/master/packages/analytics-util-storage-remote)** <br/> Storage utilities for cross domain localStorage access, with permissions | <a href="https://www.npmjs.com/package/@analytics/remote-storage-utils"><img width="360" height="22" src="https://img.shields.io/npm/dm/@analytics/remote-storage-utils.svg"></a> | **0.4.20** |
 | **[@analytics/router-utils](https://github.com/DavidWells/analytics/tree/master/packages/analytics-util-router)** <br/> Route change utilities for single page apps | <a href="https://www.npmjs.com/package/@analytics/router-utils"><img width="360" height="22" src="https://img.shields.io/npm/dm/@analytics/router-utils.svg"></a> | **0.1.1** |
 | **[@analytics/scroll-utils](https://github.com/DavidWells/analytics/tree/master/packages/analytics-util-scroll)** <br/> Scroll utility library to fire events on scroll | <a href="https://www.npmjs.com/package/@analytics/scroll-utils"><img width="360" height="22" src="https://img.shields.io/npm/dm/@analytics/scroll-utils.svg"></a> | **0.1.22** |
-| **[@analytics/segment](https://github.com/DavidWells/analytics/tree/master/packages/analytics-plugin-segment)** <br/> Segment integration for 'analytics' module for browser & node | <a href="https://www.npmjs.com/package/@analytics/segment"><img width="360" height="22" src="https://img.shields.io/npm/dm/@analytics/segment.svg"></a> | **1.1.4** |
+| **[@analytics/segment](https://github.com/DavidWells/analytics/tree/master/packages/analytics-plugin-segment)** <br/> Segment integration for 'analytics' module for browser & node | <a href="https://www.npmjs.com/package/@analytics/segment"><img width="360" height="22" src="https://img.shields.io/npm/dm/@analytics/segment.svg"></a> | **2.0.0** |
 | **[@analytics/session-storage-utils](https://github.com/DavidWells/analytics/tree/master/packages/analytics-util-storage-session)** <br/> Tiny SessionStorage utility library | <a href="https://www.npmjs.com/package/@analytics/session-storage-utils"><img width="360" height="22" src="https://img.shields.io/npm/dm/@analytics/session-storage-utils.svg"></a> | **0.0.7** |
 | **[@analytics/session-utils](https://github.com/DavidWells/analytics/tree/master/packages/analytics-util-session)** <br/> Tiny session utility library | <a href="https://www.npmjs.com/package/@analytics/session-utils"><img width="360" height="22" src="https://img.shields.io/npm/dm/@analytics/session-utils.svg"></a> | **0.1.19** |
 | **[@analytics/simple-analytics](https://github.com/DavidWells/analytics/tree/master/packages/analytics-plugin-simple-analytics)** <br/> Simple analytics plugin for 'analytics' module for browser | <a href="https://www.npmjs.com/package/@analytics/simple-analytics"><img width="360" height="22" src="https://img.shields.io/npm/dm/@analytics/simple-analytics.svg"></a> | **0.4.0** |

diff --git a/packages/analytics-core/README.md b/packages/analytics-core/README.md
@@ -740,7 +740,7 @@ The `analytics` has a robust plugin system. Here is a list of currently availabl
 | **[@analytics/remote-storage-utils](https://github.com/DavidWells/analytics/tree/master/packages/analytics-util-storage-remote)** <br/> Storage utilities for cross domain localStorage access, with permissions | <a href="https://www.npmjs.com/package/@analytics/remote-storage-utils"><img width="360" height="22" src="https://img.shields.io/npm/dm/@analytics/remote-storage-utils.svg"></a> | **0.4.20** |
 | **[@analytics/router-utils](https://github.com/DavidWells/analytics/tree/master/packages/analytics-util-router)** <br/> Route change utilities for single page apps | <a href="https://www.npmjs.com/package/@analytics/router-utils"><img width="360" height="22" src="https://img.shields.io/npm/dm/@analytics/router-utils.svg"></a> | **0.1.1** |
 | **[@analytics/scroll-utils](https://github.com/DavidWells/analytics/tree/master/packages/analytics-util-scroll)** <br/> Scroll utility library to fire events on scroll | <a href="https://www.npmjs.com/package/@analytics/scroll-utils"><img width="360" height="22" src="https://img.shields.io/npm/dm/@analytics/scroll-utils.svg"></a> | **0.1.22** |
-| **[@analytics/segment](https://github.com/DavidWells/analytics/tree/master/packages/analytics-plugin-segment)** <br/> Segment integration for 'analytics' module for browser & node | <a href="https://www.npmjs.com/package/@analytics/segment"><img width="360" height="22" src="https://img.shields.io/npm/dm/@analytics/segment.svg"></a> | **1.1.4** |
+| **[@analytics/segment](https://github.com/DavidWells/analytics/tree/master/packages/analytics-plugin-segment)** <br/> Segment integration for 'analytics' module for browser & node | <a href="https://www.npmjs.com/package/@analytics/segment"><img width="360" height="22" src="https://img.shields.io/npm/dm/@analytics/segment.svg"></a> | **2.0.0** |
 | **[@analytics/session-storage-utils](https://github.com/DavidWells/analytics/tree/master/packages/analytics-util-storage-session)** <br/> Tiny SessionStorage utility library | <a href="https://www.npmjs.com/package/@analytics/session-storage-utils"><img width="360" height="22" src="https://img.shields.io/npm/dm/@analytics/session-storage-utils.svg"></a> | **0.0.7** |
 | **[@analytics/session-utils](https://github.com/DavidWells/analytics/tree/master/packages/analytics-util-session)** <br/> Tiny session utility library | <a href="https://www.npmjs.com/package/@analytics/session-utils"><img width="360" height="22" src="https://img.shields.io/npm/dm/@analytics/session-utils.svg"></a> | **0.1.19** |
 | **[@analytics/simple-analytics](https://github.com/DavidWells/analytics/tree/master/packages/analytics-plugin-simple-analytics)** <br/> Simple analytics plugin for 'analytics' module for browser | <a href="https://www.npmjs.com/package/@analytics/simple-analytics"><img width="360" height="22" src="https://img.shields.io/npm/dm/@analytics/simple-analytics.svg"></a> | **0.4.0** |

diff --git a/packages/analytics-plugin-segment/README.md b/packages/analytics-plugin-segment/README.md
@@ -148,9 +148,16 @@ const analytics = Analytics({
 
 | Option | description |
 |:---------------------------|:-----------|
-| `writeKey` <br/>**required** - string| Your segment writeKey |
-| `flushInterval` <br/>_optional_ - boolean| Segment sdk flushInterval. Docs https://bit.ly/2H2jJMb |
+| `writeKey` <br/>**required** - string| Key that corresponds to your Segment.io project |
 | `disableAnonymousTraffic` <br/>_optional_ - boolean| Disable loading segment for anonymous visitors |
+| `host` <br/>_optional_ - string| The base URL of the API. Default: "https://api.segment.io" |
+| `path` <br/>_optional_ - string| The API path route. Default: "/v1/batch" |
+| `maxRetries` <br/>_optional_ - number| The number of times to retry flushing a batch. Default: 3 |
+| `maxEventsInBatch` <br/>_optional_ - number| The number of messages to enqueue before flushing. Default: 15 |
+| `flushInterval` <br/>_optional_ - number| The number of milliseconds to wait before flushing the queue automatically. Default: 10000 |
+| `httpRequestTimeout` <br/>_optional_ - number| The maximum number of milliseconds to wait for an http request. Default: 10000 |
+| `disable` <br/>_optional_ - boolean| Disable the analytics library. All calls will be a noop. Default: false. |
+| `httpClient` <br/>_optional_ - HTTPFetchFn| Supply a default http client implementation |
 
 
 ## Additional examples

diff --git a/packages/analytics/README.md b/packages/analytics/README.md
@@ -740,7 +740,7 @@ The `analytics` has a robust plugin system. Here is a list of currently availabl
 | **[@analytics/remote-storage-utils](https://github.com/DavidWells/analytics/tree/master/packages/analytics-util-storage-remote)** <br/> Storage utilities for cross domain localStorage access, with permissions | <a href="https://www.npmjs.com/package/@analytics/remote-storage-utils"><img width="360" height="22" src="https://img.shields.io/npm/dm/@analytics/remote-storage-utils.svg"></a> | **0.4.20** |
 | **[@analytics/router-utils](https://github.com/DavidWells/analytics/tree/master/packages/analytics-util-router)** <br/> Route change utilities for single page apps | <a href="https://www.npmjs.com/package/@analytics/router-utils"><img width="360" height="22" src="https://img.shields.io/npm/dm/@analytics/router-utils.svg"></a> | **0.1.1** |
 | **[@analytics/scroll-utils](https://github.com/DavidWells/analytics/tree/master/packages/analytics-util-scroll)** <br/> Scroll utility library to fire events on scroll | <a href="https://www.npmjs.com/package/@analytics/scroll-utils"><img width="360" height="22" src="https://img.shields.io/npm/dm/@analytics/scroll-utils.svg"></a> | **0.1.22** |
-| **[@analytics/segment](https://github.com/DavidWells/analytics/tree/master/packages/analytics-plugin-segment)** <br/> Segment integration for 'analytics' module for browser & node | <a href="https://www.npmjs.com/package/@analytics/segment"><img width="360" height="22" src="https://img.shields.io/npm/dm/@analytics/segment.svg"></a> | **1.1.4** |
+| **[@analytics/segment](https://github.com/DavidWells/analytics/tree/master/packages/analytics-plugin-segment)** <br/> Segment integration for 'analytics' module for browser & node | <a href="https://www.npmjs.com/package/@analytics/segment"><img width="360" height="22" src="https://img.shields.io/npm/dm/@analytics/segment.svg"></a> | **2.0.0** |
 | **[@analytics/session-storage-utils](https://github.com/DavidWells/analytics/tree/master/packages/analytics-util-storage-session)** <br/> Tiny SessionStorage utility library | <a href="https://www.npmjs.com/package/@analytics/session-storage-utils"><img width="360" height="22" src="https://img.shields.io/npm/dm/@analytics/session-storage-utils.svg"></a> | **0.0.7** |
 | **[@analytics/session-utils](https://github.com/DavidWells/analytics/tree/master/packages/analytics-util-session)** <br/> Tiny session utility library | <a href="https://www.npmjs.com/package/@analytics/session-utils"><img width="360" height="22" src="https://img.shields.io/npm/dm/@analytics/session-utils.svg"></a> | **0.1.19** |
 | **[@analytics/simple-analytics](https://github.com/DavidWells/analytics/tree/master/packages/analytics-plugin-simple-analytics)** <br/> Simple analytics plugin for 'analytics' module for browser | <a href="https://www.npmjs.com/package/@analytics/simple-analytics"><img width="360" height="22" src="https://img.shields.io/npm/dm/@analytics/simple-analytics.svg"></a> | **0.4.0** |

diff --git a/site/main/source/plugins/segment.md b/site/main/source/plugins/segment.md
@@ -145,9 +145,16 @@ const analytics = Analytics({
 
 | Option | description |
 |:---------------------------|:-----------|
-| `writeKey` <br/>**required** - string| Your segment writeKey |
-| `flushInterval` <br/>_optional_ - boolean| Segment sdk flushInterval. Docs https://bit.ly/2H2jJMb |
+| `writeKey` <br/>**required** - string| Key that corresponds to your Segment.io project |
 | `disableAnonymousTraffic` <br/>_optional_ - boolean| Disable loading segment for anonymous visitors |
+| `host` <br/>_optional_ - string| The base URL of the API. Default: "https://api.segment.io" |
+| `path` <br/>_optional_ - string| The API path route. Default: "/v1/batch" |
+| `maxRetries` <br/>_optional_ - number| The number of times to retry flushing a batch. Default: 3 |
+| `maxEventsInBatch` <br/>_optional_ - number| The number of messages to enqueue before flushing. Default: 15 |
+| `flushInterval` <br/>_optional_ - number| The number of milliseconds to wait before flushing the queue automatically. Default: 10000 |
+| `httpRequestTimeout` <br/>_optional_ - number| The maximum number of milliseconds to wait for an http request. Default: 10000 |
+| `disable` <br/>_optional_ - boolean| Disable the analytics library. All calls will be a noop. Default: false. |
+| `httpClient` <br/>_optional_ - HTTPFetchFn| Supply a default http client implementation |
 
 ## Additional examples
 

diff --git a/site/main/source/utils/scroll.md b/site/main/source/utils/scroll.md
@@ -50,4 +50,5 @@ detachScrollListener()
 
 ## Alternative libraries
 
-- [Update On Scroll (uos)](https://github.com/vaneenige/uos)
+- [Update On Scroll (uos)](https://github.com/vaneenige/uos)
+- [overunder](https://github.com/estrattonbailey/overunder)