{"bugs":{"url":"https://github.com/sanity-io/sanity/issues"},"dist":{"shasum":"fe7499dc07485016d63a0b544814568af6fd145f","tarball":"https://registry.npmjs.org/@sanity/document-store/-/document-store-0.128.0-next.124ce231.tgz","fileCount":27,"integrity":"sha512-gMgYzsiA2XhhntitxkUqX/5wUlCklnoQx5PkeEpIOlCG3o5Sfw8FKnmphvmx/rqBf2FHgh+9uYsKLd0Eki9HuA==","signatures":[{"sig":"MEYCIQC1ucVCDxekIXW/Lab7y1QoTpHJ8JsBCZDF2tbh/lGhVAIhAN3ozsJ3hDxZONBT7vFtKnR1FulrhaVLReCzhq/SLrrG","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":27314},"main":"./lib/index.js","name":"@sanity/document-store","author":{"name":"Sanity.io","email":"hello@sanity.io"},"readme":"# Document store\n\nSanity / gradient document store\n\n## Example\n```js\n// If you are interested in everything that happens with document `lol42`\nconst subscription = documents.byId(\"lol42\").subscribe(event => {\n  console.log('Something happened with document lol42!', event)\n})\n\n// After a while, when you are no longer interested in updates fom document `lol42`:\nsubscription.unsubscribe()\n```\n\n## How it works\nWhen you add a subscriber to a document the first thing that happens is that the subscriber function is called with a snapshot of the document's current state. This happens as soon as the snapshot is retrieved. If there is a cached version of it on the client, the snapshot is received immediately (synchronously).\n\nFrom that moment on, you will receive a new event every time something happens to the document, until you unsubscribe again.\n\n## API\n\n- `createDocumentStore({serverConnection: ServerConnection}) : DocumentStore`\n\nServerConnection must be an object with the following api:\n- `byId(id : string) : Observable<DocumentEvent>`\n- `query(query : string) : Observable<QueryResultEvent>`\n(todo, add more)\n\n### DocumentStore\n\n### Query methods\n- `byId(id : string) : Observable<DocumentEvent>`\n- `byIds(ids : Array<string>) : Observable<QueryResultEvent>`\n- `query(query : string) : Observable<QueryResultEvent>`\n\n### Mutation methods\n- `update(id : string, spec : UpdateSpec) : Observable<OperationEvent>`\n- `create(document : Document) : Observable<OperationEvent>`\n- `replace(documentId : string, document : Document) : Observable<OperationEvent>`\n- `createOrReplace(document : Document) : Observable<OperationEvent>`\n- `delete(documentId : string) :  : Observable<OperationEvent>`\n\n### Document\n- `_id : string`\n- `_type : string`\n\n### DocumentEventType\n\n### DocumentEvent\n- `type : string` either one of `snapshot`, `update`\n- `snapshot : Document`\n","license":"MIT","scripts":{"tap":"tap --node-arg=--require --node-arg=babel-register test/*.test.js","test":"npm run tap && npm run examples","clean":"rimraf lib","examples":"echo 'Running examples'; for i in examples/*.js; do echo '\n## '$i' ----\n' && node $i; done"},"_npmUser":{"name":"bjoerge","email":"bjoerge@gmail.com"},"homepage":"https://www.sanity.io/","keywords":["sanity","cms","headless","realtime","content","document-store"],"repository":{"url":"git+https://github.com/sanity-io/sanity.git","type":"git"},"description":"Sanity / gradient document store","directories":{},"maintainers":[{"name":"bjoerge","email":"bjoerge@gmail.com"},{"name":"kristofferj","email":"kristoffer@bengler.no"},{"name":"rexxars","email":"rexxars@gmail.com"},{"name":"sanity-io","email":"hello@sanity.io"},{"name":"simenss","email":"simen@bengler.no"},{"name":"skogsmaskin","email":"per.kristian.nordnes@gmail.com"},{"name":"thomax","email":"thomas@bengler.no"}],"dependencies":{"lodash":"^4.17.4","nano-pubsub":"^1.0.2","@sanity/mutator":"0.128.0-next.124ce231","@sanity/observable":"0.128.0-next.124ce231"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"tap":"^11.0.1","rimraf":"^2.6.2","in-publish":"^2.0.0","get-random-values":"^1.2.0"},"_npmOperationalInternal":{"tmp":"tmp/document-store_0.128.0-next.124ce231_1521719648616_0.7458168693556293","host":"s3://npm-registry-packages"},"_id":"@sanity/document-store@0.128.0-next.124ce231","version":"0.128.0-next.124ce231"}