Skip to content
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

[Fix] Note on eventual consistency #367

Merged
merged 2 commits into from
Jun 27, 2024
Merged

[Fix] Note on eventual consistency #367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f689d36
[Fix] Note on eventual consistency
Dvergar Oct 10, 2023
a999f8a
[Fix] Moved note to readme
Dvergar Jun 26, 2024
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
7 changes: 7 additions & 0 deletions packages/sdk/src/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,10 @@ You can find the entire definition [on this page](interfaces/types_DocumentTypes
## Enums, Types, Interfaces and general Methods

If you want to check out some types, interfaces and general methods, you can find them all bundled [under the modules page](modules).

## Eventual Consistency

Because of the nature of an async stream, be aware that you may react on an item that has an old state.
Eventual consistency means that you will _eventually_ get the correct state from the stream.

See: https://en.wikipedia.org/wiki/Eventual_consistency
7 changes: 7 additions & 0 deletions packages/sdk/src/README_HTML.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,10 @@ You can find the entire definition [on this page](interfaces/types_DocumentTypes
## Enums, Types, Interfaces and general Methods

If you want to check out some types, interfaces and general methods, you can find them all bundled [under the modules page](modules).

## Eventual Consistency

Because of the nature of an async stream, be aware that you may react on an item that has an old state.
Eventual consistency means that you will _eventually_ get the correct state from the stream.

See: https://en.wikipedia.org/wiki/Eventual_consistency
Loading