{"bugs":{"url":"https://github.com/sanity-io/sanity/issues"},"dist":{"shasum":"66f3dcc50c189975ae07aa65d419b4a304a99c91","tarball":"https://registry.npmjs.org/@sanity/document-store/-/document-store-0.135.7-canary.241.tgz","fileCount":21,"integrity":"sha512-b+Q5JBshG0lVNsfloQUkcuXzgqMmRbYH7CZ6x4lxo3y0XRDp2Oamu0tySk9ySeFVQ12FiN9CEgFWvuje5BDTEA==","signatures":[{"sig":"MEUCIDuVvgxNiRJuwE55SZOrvCQSJ1PI2w7qopu5L2zlQzecAiEAwBuUcRBTabl/U2v3YdBNs7SwiUJ2Bx03m7Uhp1vfGtk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":31553,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJb6VxnCRA9TVsSAnZWagAA1gUP/2Sj6gxqFXt3kFgtkas2\nuaKeU+0dtZWZQJb/NTEx/tRrmQ5szLjLkBqoX0tOt92h7rw06P0i9yhBK6O3\nR6lC0mqUZAa7lm26ebIvNGq0pGw5O76ckjPqsoRuO/LBZEXlBa0tPNpRXXMK\noFBBqjQ+p3vhhZeWNGOoPW5Ne73fskFmXaEVzmHisDtD1yhWDt8NH4e+V8oq\nEognKK3GJxhsviqB6NKnxx2uizwbj3I0e3rpmk5tNNCNVZ4/3ZvQAn9b68sP\n2fSZWIUOPW3T7gCTMhXRm0MVpv6wBFU+zrBQdMSmc4ogASp5xR8T1Ntvcu7J\n0Pvb2mLZvCvXahUgVyyd+5xkZSDAV9veNq34nyCUGHVSqudJ6iQlmZl9DqUT\ndAX/Ri0nEyBGGiolr9+f/CDU/IUiLAFus51Oqq/yuKUAyFgBRA863/KLV4RZ\nhzvRUYoZjb1U4ltHCHXPv6cSsXjSXGKxhUWHMnmcyK4v199mZdzMraA0ev3i\nFtUigAVvIrrTLf6bBwRTPpIDitGdCWV0kbXT56Pb4GqX0ADS+kM8VFOO42TN\ne7/BGeO6r2gsdP1EFHawCUVNxZUuidzKo8DumhdGOc28bpNndqjKgRgnbaZn\ngZmqqUauRPQKzGX9UmoMdI1oe9jsBP4zYO7m1A6Bp8d3SmyBw/dcZbKTiP3n\nEHyL\r\n=4/et\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./lib/index.js","name":"@sanity/document-store","_from":"file:sanity-document-store-0.135.7-canary.241.tgz","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","gitHead":"c18deba40e003f35ace83d8975ab1f70d6b4843a","license":"MIT","scripts":{"clean":"rimraf lib","examples":"echo 'Running examples'; for i in examples/*.js; do echo '\n## '$i' ----\n' && node $i; done"},"_npmUser":{"name":"mariuslundgard","email":"studio@mariuslundgard.com"},"homepage":"https://www.sanity.io/","keywords":["sanity","cms","headless","realtime","content","document-store"],"_resolved":"","_integrity":"","repository":{"url":"git+https://github.com/sanity-io/sanity.git","type":"git"},"_npmVersion":"6.4.1","description":"Sanity / gradient document store","directories":{},"maintainers":[{"name":"bjoerge","email":"bjoerge@gmail.com"},{"name":"kmelve","email":"knut.melvaer@gmail.com"},{"name":"kristofferj","email":"kristoffer@sanity.io"},{"name":"mariuslundgard","email":"studio@mariuslundgard.com"},{"name":"rexxars","email":"espen@hovlandsdal.com"},{"name":"simenss","email":"simen@bengler.no"},{"name":"skogsmaskin","email":"per.kristian.nordnes@gmail.com"},{"name":"thomax","email":"thomas@sanity.io"}],"_nodeVersion":"10.11.0","dependencies":{"rxjs":"^6.1.0","lodash":"^4.17.4","nano-pubsub":"^1.0.2","@sanity/mutator":"0.135.7-canary.241+c18deba40"},"_hasShrinkwrap":false,"readmeFilename":"README.md","_npmOperationalInternal":{"tmp":"tmp/document-store_0.135.7-canary.241_1542020199166_0.831253735444845","host":"s3://npm-registry-packages"},"_id":"@sanity/document-store@0.135.7-canary.241","version":"0.135.7-canary.241"}