Skip to content

Add flush policy docs #4480

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.

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
merged 19 commits into from
Mar 28, 2023
Merged

Add flush policy docs #4480

merged 19 commits into from
Mar 28, 2023

Conversation

niallzato
Copy link
Contributor

@niallzato niallzato added the KCS label Mar 27, 2023
@niallzato niallzato marked this pull request as ready for review March 27, 2023 16:29
@niallzato niallzato requested a review from a team as a code owner March 27, 2023 16:29
@niallzato niallzato requested review from rchinn1 and removed request for a team March 27, 2023 16:29
Copy link
Contributor

@rchinn1 rchinn1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @niallzato - thanks for submitting this. I've left some comments (and a few questions) to align this a bit more with our style guide. After that, we'll add this to our docs!

// ...
flushPolicies: policies,
});
// If we detect the user disconnects from the network remove all flush policies,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do the instances of we in lines 377-380 all refer to Segment?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rchinn-segment thanks for all the suggestions. Correct, we are referring to Segment for these instances. Specifically, the Segment library initialized in the app. We could say something like the following, perhaps:

// that way the Segment client won't keep attempting to send events to Segment, but they will still // be stored for future upload. // If the network comes back up, the Segment client adds the policies back

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds great @niallzato - will get these updates in our upcoming docs deploy!

@rchinn1 rchinn1 merged commit 1c46130 into develop Mar 28, 2023
@rchinn1 rchinn1 deleted the niall/fp branch March 28, 2023 16:48
@github-actions
Copy link
Contributor

Thank you for your contribution! Your pull request is merged, but may take a day or two to appear on the site.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants