Detailed documentation/test missing for ingestSnapshot #254

Activity

1. curran

   changed the title [-]Test for ingestSnapshot[/-] [+]Detailed documentation/test missing for ingestSnapshot[/+] on Nov 5, 2018
2. curran commented on Nov 5, 2018

   

   curran

   on Nov 5, 2018

   Last edited by curran

   ContributorAuthor

   More actions

   In particular, I had difficulty finding out how to construct a snapshot from a fetched ShareDB.Doc.

   I eventually did get it to work, and here's the solution:

   const doc = connection.get('examples', 'textarea');
   const snapshot = {
     v: doc.version,
     data: doc.data
   };

   This may be a good example to put in the README.
3. ericyhwang

   added a commit that references this issue on Nov 6, 2018

   Clarify README for `doc.ingestSnapshot(snapshot, callback)`

   ...

   a67ad42
4. ericyhwang commented on Nov 6, 2018

   

   ericyhwang

   on Nov 6, 2018

   Contributor

   More actions

   Yup, the documentation isn't as precise as it could be. The JSDoc for ingestSnapshot is clearer - it says it requires v, data, and type fields on the snapshot param.
   https://github.com/share/sharedb/blob/v1.0.0-beta.14/lib/client/doc.js#L150

   I've updated the README in a67ad42 to clarify the format for the param.

   Any additional clarifications on the documentation that you'd like?

   Re the tests, ingestSnapshot gets covered indirectly by doc fetch/subscribe. As you say, it could be useful to have a simple test as "enforced" documentation. If you want to add one, that'd be great!
5. curran commented on Nov 6, 2018

   

   curran

   on Nov 6, 2018

   ContributorAuthor

   More actions

   Thanks a ton @ericyhwang for making that update!
6. curran commented on Nov 6, 2018

   

   curran

   on Nov 6, 2018

   ContributorAuthor

   More actions

   Closing as the update is IMO suffucient.
7. curran

   closed this as completedon Nov 6, 2018
8. FernhillFable

   added a commit that references this issue on Aug 13, 2025

   Clarify README for `doc.ingestSnapshot(snapshot, callback)`

   ...

   6ef21cf
9. elizabeClark

   added a commit that references this issue on Sep 19, 2025

   Clarify README for `doc.ingestSnapshot(snapshot, callback)`

   ...

   66f9167