Skip to content

Commit bb11214

Browse files
authored
Update README.md
1 parent 78240c4 commit bb11214

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ Populate the fields on `doc` with a snapshot of the document from the server, an
205205
fire events on subsequent changes.
206206

207207
`doc.ingestSnapshot(snapshot, callback)`
208-
Ingest snapshot data. This data must include a version, snapshot and type. This is used both to ingest data that was exported with a webpage and data that was received from the server during a fetch.
208+
Ingest snapshot data. This data must include a version, snapshot and type. This method is generally called interally as a result of fetch or subscribe and not directly. However, it may be called directly to pass data that was transferred to the client external to the client's ShareDB connection, such as snapshot data sent along with server rendering of a webpage.
209209

210210
`doc.destroy()`
211211
Unsubscribe and stop firing events.

0 commit comments

Comments
 (0)