remotestorage / remotestorage.js

⬡ JavaScript client library for integrating remoteStorage in apps
https://remotestoragejs.readthedocs.io
MIT License
2.3k stars 141 forks source link

Document sync events #1289

Closed raucao closed 1 year ago

raucao commented 1 year ago

While implementing a custom sync progress UI for visual feedback when syncing many items at once, I noticed that the library's sync events (which are used by the widget for example) aren't officially documented at all.

I'll take care of it, since I also have a branch incoming, which adds a bit more information to the events and also fixes a small connect widget issue when there are sync errors.

raucao commented 1 year ago

I was actually wrong about this:

https://remotestoragejs.readthedocs.io/en/latest/js-api/remotestorage.html#sync-req-done