Skip to content

Commit dbccc62

Browse files
authored
Add defaultSettings's type to documentation (#716)
Include a better description of the expected value on the `defaultSettings` prop.
1 parent b95788b commit dbccc62

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ You must pass at least the `writeKey`. Additional configuration options are list
114114
| `maxBatchSize` | 1000 | How many events to send to the API at once |
115115
| `trackAppLifecycleEvents` | false | Enable automatic tracking for [app lifecycle events](https://segment.com/docs/connections/spec/mobile/#lifecycle-events): application installed, opened, updated, backgrounded) |
116116
| `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)) |
117-
| `defaultSettings` | undefined | Settings that will be used if the request to get the settings from Segment fails |
117+
| `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/master/packages/core/src/types.ts#L291) |
118118
| `autoAddSegmentDestination`| true | Set to false to skip adding the SegmentDestination plugin |
119119
| `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).|
120120
| `proxy` | undefined | `proxy` is a batch url to post to instead of 'https://api.segment.io/v1/b'. |

0 commit comments

Comments
 (0)