[AIT-280] Update JS LiveObjects documentation for apply-on-ACK#3161
[AIT-280] Update JS LiveObjects documentation for apply-on-ACK#3161lawrence-forooghian wants to merge 1 commit intomainfrom
Conversation
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
lawrence-forooghian
force-pushed
the
AIT-280-LiveObjects-apply-on-ACK
branch
from
489f859 to
1038704
Compare
lawrence-forooghian
force-pushed
the
AIT-280-LiveObjects-apply-on-ACK
branch
from
1038704 to
6dfce76
Compare
lawrence-forooghian
force-pushed
the
AIT-280-LiveObjects-apply-on-ACK
branch
from
6dfce76 to
b88c57e
Compare
lawrence-forooghian
added
review-app
lawrence-forooghian
force-pushed
the
AIT-280-LiveObjects-apply-on-ACK
branch
from
b88c57e to
1ee26c2
Compare
GregHolmes
force-pushed
the
AIT-280-LiveObjects-apply-on-ACK
branch
from
1ee26c2 to
8531f8b
Compare
GregHolmes
left a comment
GregHolmes
left a comment
There was a problem hiding this comment.
Only one comment, but not a breaker.
| When a client publishes an operation, the operation is applied to its local objects as soon as the operation is acknowledged by the Ably system. This means that when a mutation method's promise resolves, the operation has already been applied and you can immediately read the updated state. | ||
| </Aside> | ||
|
|
||
| <Aside data-type='important'> |
There was a problem hiding this comment.
Is this Aside needed? If the user is trying to implement with Swift or Java, they'll have the language relevant to them.
There was a problem hiding this comment.
I was thinking that perhaps if they're using JS as their "main" SDK and then just porting their code across to Swift and Kotlin, then they might not re-read all the documentation for those two as well.
There was a problem hiding this comment.
Not really against having this aside, as we expect it to be removed soon anyway as we add apply-on-ACK to swift and kotlin.
GregHolmes
force-pushed
the
AIT-280-LiveObjects-apply-on-ACK
branch
from
8531f8b to
0b42d7d
Compare
This reflects the functionality implemented in [1], based on the DR [2] and spec [3]. Written by Claude. [1] ably/ably-js#2155 [2] https://ably.atlassian.net/wiki/spaces/LOB/pages/4671832082/LODR-054+SDK+apply+operations+on+ACK) [3] ably/specification#419
lawrence-forooghian
force-pushed
the
AIT-280-LiveObjects-apply-on-ACK
branch
from
0b42d7d to
9cb65ee
Compare
| When a client publishes an operation, the operation is applied to its local objects as soon as the operation is acknowledged by the Ably system. This means that when a mutation method's promise resolves, the operation has already been applied and you can immediately read the updated state. | ||
| </Aside> | ||
|
|
||
| <Aside data-type='important'> |
There was a problem hiding this comment.
Not really against having this aside, as we expect it to be removed soon anyway as we add apply-on-ACK to swift and kotlin.
m-hulbert
added
Do not merge
5 participants
Description
This reflects the functionality implemented in ably/ably-js#2155, based on the DR and ably/specification#419. Written by Claude.
Checklist