We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
checkoutPair
1 parent 2d17ead commit 795766bCopy full SHA for 795766b
packages/sanity/src/core/store/_legacy/document/document-store.ts
@@ -49,7 +49,13 @@ function getIdPairFromPublished(publishedId: string): IdPair {
49
* @hidden
50
* @beta */
51
export interface DocumentStore {
52
- /** @internal */
+ /**
53
+ * Checks out a document (with its published and draft version) for real-time editing.
54
+ * Note that every call to this function will open a new listener to the server.
55
+ * It's recommended to use the helper functions on `pair` below which will re-use a single connection.
56
+ *
57
+ * @internal
58
+ **/
59
checkoutPair: (idPair: IdPair) => Pair
60
initialValue: (
61
opts: InitialValueOptions,
0 commit comments