Add handleConflict to documentation
Opened this issue · 4 comments
Looks like an exciting tool!
I'd just like to request if all docs could be added in one place (or at least interlinked), specifically could you add handleConflict
(under SDBStore
it appears)?
Also, you have a number of files with the method getChangesToRecord
, and although there is one non-empty version of this method, there is no documentation of it, and it doesn't seem to be called anywhere.
Thanks!
Hello!
I'd just like to request if all docs could be added in one place (or at least interlinked), specifically could you add handleConflict (under SDBStore it appears)?
I'm not sure what you mean. All documentation is in API.md
? handleConflict
isn't actually documented yet. It's only being demonstrated in the counters example.
As you've noticed getChangesToRecord
to record isn't being used by the SyncedDB backend. I think it's mostly there as a historical artefact. I thought it would be needed to implement the backend features but it wasn't. I should probably take it out?
Sure, was just asking if you would document handleConflict
there. And yeah, it would be really nice to have the historical artifacts removed (or put in a branch if you want easy access to them), as otherwise, can be a little distracting from examining how things are to work...
handleConflict isn't actually documented yet. It's only being demonstrated in the counters example.
I got this after the getting the todo example running:
Uncaught TypeError: db.stores[msg.storeName].handleConflict is not a function
Very cool project. Nice work 👍
SDBObjectStore
seems not to implement handleConflict
in the first place. Only examples/counters
implements it as a custom handler. Do you have any suggestion about this? @paldepind