Skip to content

Commit 5e59ada

Browse files
authored
chore: update readme to include errorHandler and flushPolicies (#771)
1 parent b8e8864 commit 5e59ada

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,13 +113,15 @@ You must pass at least the `writeKey`. Additional configuration options are list
113113
| `logger` | undefined | Custom logger instance to expose internal Segment client logging. |
114114
| `flushAt` | 20 | How many events to accumulate before sending events to the backend. |
115115
| `flushInterval` | 30 | In seconds, how often to send events to the backend. |
116+
| `flushPolicies` | undefined | Add more granular control for when to flush, see [Adding or removing policies](#adding-or-removing-policies) |
116117
| `maxBatchSize` | 1000 | How many events to send to the API at once |
117118
| `trackAppLifecycleEvents` | false | Enable automatic tracking for [app lifecycle events](https://segment.com/docs/connections/spec/mobile/#lifecycle-events): application installed, opened, updated, backgrounded) |
118119
| `trackDeepLinks` | false | Enable automatic tracking for when the user opens the app via a deep link (Note: Requires additional setup on iOS, [see instructions](#ios-deep-link-tracking-setup)) |
119120
| `defaultSettings` | undefined | Settings that will be used if the request to get the settings from Segment fails. Type: [SegmentAPISettings](https://github.com/segmentio/analytics-react-native/blob/c0a5895c0c57375f18dd20e492b7d984393b7bc4/packages/core/src/types.ts#L293-L299) |
120121
| `autoAddSegmentDestination`| true | Set to false to skip adding the SegmentDestination plugin |
121122
| `storePersistor` | undefined | A custom persistor for the store that `analytics-react-native` leverages. Must match `Persistor` interface exported from [sovran-react-native](https://github.com/segmentio/sovran-react-native).|
122123
| `proxy` | undefined | `proxy` is a batch url to post to instead of 'https://api.segment.io/v1/b'. |
124+
| `errorHandler` | undefined | Create custom actions when errors happen, see [Handling errors](#handling-errors) |
123125

124126

125127
\* The default value of `debug` will be false in production.

0 commit comments

Comments
 (0)