{"bugs":{"url":"https://github.com/sanity-io/sanity/issues"},"dist":{"shasum":"da8381abdae4a4541b005cde74760fb9cea99ae0","tarball":"https://registry.npmjs.org/@sanity/document-store/-/document-store-0.136.1-canary.27.tgz","fileCount":21,"integrity":"sha512-9r9+hA5NTRJJ8BRj5hOwWiebgPuz+eCNFWBBP/CVHqHL9DDzX2jpmIWMUD+S3xAUegqUsmEKBkBKQ3czaaUFbA==","signatures":[{"sig":"MEYCIQCQVZFXSycdwJiPC6gs/Ss+P4Ez2fPigv8Hxpv1U8TYRwIhAKjJV2/084DLmhtWRaZZNP5dqSd80TRUcxhx2Asmi4OS","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":32199,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJb/w1NCRA9TVsSAnZWagAAw14QAIwejsgsp1856VRvWjVD\nq46oggFJIOBstZhpF791x9uNRbbRZ84WTLcoMLw9lhoZWK62/86oywuAn7o5\nED7CRZys9AbFmqubklHKpq36IehTJE9Nh+2UO/zYPkr3IxfCD184T96i5pU5\nbWBr3ga1NEMvrVsgyLu6fkMLiY+etTaC2X3+HWWfCvuikMkOuNRF/weHs9/e\nRJMXnT4xS3eifXU1nTKB1Nnzk0iI+yN4WzG9XIzwLSlmTqwwh9Dauud3hgap\noq791QPeYAMs0MZxueMjI+qRAPZKsNZKCd9lb0BaRRhkBtWhNpSGnxmI6vVy\nLFqcAj5nsE20O4dkLTj6J2TzWrJUOz3SBD81eN3Qe5nAU0DeBUzHpjXZk0FX\nHsIvy3hJlVZ6zbn5iHw2+JR+1PYoNjQNszsrFRHRkkF49pIkLKj8rcTYcXs1\n5pvGvlvV3UWABNd8/GYak+ucKPyRfgsBoaioLkJAZYyf5zD0XaQp5XttXl+C\nwLxyacQBeTBD/yH0K2nRCBoyY8hTMi0qdKGiu5BnsifzG41pjZqrQXG10+OS\ncgbsBsVem4hgBTeUA1botkphgOGmwhVFjE4SU+oM2Su31dt3rIESbWrxiCZl\n/o5rwZ2ip+ijCtmIiJuJwAAdRXD/2NFzh9DbEw0RYMQ+gpcWLc4AVfs+iXfU\nCxRD\r\n=Nnia\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./lib/index.js","name":"@sanity/document-store","_from":"file:sanity-document-store-0.136.1-canary.27.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":"3e04fc24acfeddad82ebd09b08e657e7ccb7fd26","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":"rexxars","email":"espen@hovlandsdal.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":"sanity-io","email":"developers@sanity.io"},{"name":"simenss","email":"simen@bengler.no"},{"name":"skogsmaskin","email":"per.kristian.nordnes@gmail.com"},{"name":"thomax","email":"thomas@sanity.io"}],"_nodeVersion":"10.8.0","dependencies":{"rxjs":"^6.1.0","lodash":"^4.17.4","nano-pubsub":"^1.0.2","@sanity/mutator":"0.136.1-canary.27+3e04fc24a"},"_hasShrinkwrap":false,"readmeFilename":"README.md","_npmOperationalInternal":{"tmp":"tmp/document-store_0.136.1-canary.27_1543441741261_0.11944012533010984","host":"s3://npm-registry-packages"},"_id":"@sanity/document-store@0.136.1-canary.27","version":"0.136.1-canary.27"}