Skip to content

Commit c119b93

Browse files
committed
add disable setting to node docs
1 parent c61bbc8 commit c119b93

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

src/connections/sources/catalog/libraries/server/node/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -286,6 +286,8 @@ Setting | Details
286286
`maxEventsInBatch` _number_ | The number of messages to enqueue before flushing. The default is: `15`
287287
`flushInterval` _number_ | The number of milliseconds to wait before flushing the queue automatically. The default is: `10000`
288288
`httpRequestTimeout` | The maximum number of milliseconds to wait for an http request. The default is: `10000`
289+
`disable` | Disable the analytics library for testing. The default is: `false`
290+
289291
290292
## Graceful shutdown
291293
Avoid losing events after shutting down your console. Call `.closeAndFlush()` to stop collecting new events and flush all existing events. If a callback on an event call is included, this also waits for all callbacks to be called, and any of their subsequent promises to be resolved.

src/connections/sources/catalog/libraries/server/node/migration.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,12 @@ If you're using the [classic version of Analytics Node.js](/docs/connections/sou
6060
```
6161
* The `flushAt` configuration option changed to `maxEventsInBatch`.
6262

63+
* The `flushAt` configuration option changed to `maxEventsInBatch`.
64+
65+
* The `enable` setting (for disabling analytics during tests) has become `disable`. `enable: false` -> `disable: true`.
66+
6367
#### Removals
6468
The updated Analytics Node.js removed these configuration options:
65-
- `enable`
6669
- `errorHandler` (see the docs on [error handling](/docs/connections/sources/catalog/libraries/server/node//#error-handling) for more information)
6770

6871
The updated Analytics Node.js library removed undocumented behavior around `track` properties
@@ -87,4 +90,4 @@ analytics.track({
8790
myProp: 'abc'
8891
}
8992
})
90-
```
93+
```

0 commit comments

Comments
 (0)