Skip to content

feat: updated README #1069

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sunitaprajapati89 merged 2 commits into from
May 8, 2025
Merged

feat: updated README #1069

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d9ff708
feat: updated README
sunitaprajapati89 Apr 30, 2025
fcbebfb
feat : made the cdnproxy note bold and more alarming
sunitaprajapati89 May 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ You must pass at least the `writeKey`. Additional configuration options are list
| `storePersistor` | undefined | A custom persistor for the store that `analytics-react-native` leverages. Must match [`Persistor`](https://github.com/segmentio/analytics-react-native/blob/master/packages/sovran/src/persistor/persistor.ts#L1-L18) interface exported from [sovran-react-native](https://github.com/segmentio/analytics-react-native/blob/master/packages/sovran). |
| `proxy` | undefined | `proxy` is a batch URL to post the events. Enable `useSegmentEndpoint` if proxy domain is provided and you want to append the Segment endpoints automatically. If you want to completely customize the proxy by providing a custom URL, disable `useSegmentEndpoint`. Default value is `false`. |
| `errorHandler` | undefined | Create custom actions when errors happen, see [Handling errors](#handling-errors). |
| `cdnProxy` | undefined | Sets an alternative CDN host for settings retrieval. Enable `useSegmentEndpoint` if cdnProxy domain is provided and you want to append the Segment endpoints automatically. |
| `cdnProxy` | undefined | Sets an alternative CDN host for settings retrieval. Enable `useSegmentEndpoint` if cdnProxy domain is provided and you want to append the Segment endpoints automatically. Note - Prior to version 2.20.4, whatever was provided as the cdnProxy in the config was automatically appended with /write-key/settings. Starting from v2.20.4, this behavior has changed—now, the SDK will behave according to `useSegmentEndpoints` flag. |
| `useSegmentEndpoint` | false | Set to `true` to automatically append the Segment endpoints when using `proxy` or `cdnProxy` to send or fetch settings. This will enable automatic routing to the appropriate endpoints. |


Expand Down
Loading