{"action":"created","issue":{"url":"https://api.github.com/repos/hoodiehq/pouchdb-hoodie-local-changes/issues/4","labels_url":"https://api.github.com/repos/hoodiehq/pouchdb-hoodie-local-changes/issues/4/labels{/name}","comments_url":"https://api.github.com/repos/hoodiehq/pouchdb-hoodie-local-changes/issues/4/comments","events_url":"https://api.github.com/repos/hoodiehq/pouchdb-hoodie-local-changes/issues/4/events","html_url":"https://github.com/hoodiehq/pouchdb-hoodie-local-changes/issues/4","id":92717267,"number":4,"title":"can we find a clearer name than `api.getLocalChanges()`?","user":{"login":"gr2m","id":39992,"avatar_url":"https://avatars.githubusercontent.com/u/39992?v=3","gravatar_id":"","url":"https://api.github.com/users/gr2m","html_url":"https://github.com/gr2m","followers_url":"https://api.github.com/users/gr2m/followers","following_url":"https://api.github.com/users/gr2m/following{/other_user}","gists_url":"https://api.github.com/users/gr2m/gists{/gist_id}","starred_url":"https://api.github.com/users/gr2m/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/gr2m/subscriptions","organizations_url":"https://api.github.com/users/gr2m/orgs","repos_url":"https://api.github.com/users/gr2m/repos","events_url":"https://api.github.com/users/gr2m/events{/privacy}","received_events_url":"https://api.github.com/users/gr2m/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":31,"created_at":"2015-07-02T19:37:45Z","updated_at":"2015-07-03T22:20:27Z","closed_at":null,"body":"our API returns an array of documents that have changed locally and not yet replicated to remote. But somehow our current API reads like it would return the delta changes that have not been synced, instead of the entire documents:\r\n\r\n```js\r\napi.getLocalChanges()\r\n.then(function(changes) {\r\n  // what is changes here?\r\n})\r\n```\r\n\r\nI wonder if we could make it more clear that the API returns an array of changes instead of just docs, like \r\n\r\n```js\r\napi.getLocallyChangedDocs()\r\n.then(function(changedDocs) {\r\n  // array of docs with local changes\r\n})\r\n```\r\n\r\nAnother idea would be to make an API that behaves similar to `db.changes()`, like\r\n\r\n```js\r\ndb.localChanges({\r\n  remote: 'remoteDb',\r\n  include_docs: true,\r\n  // etc\r\n})\r\n```\r\n\r\nbut that feels like to low level. \r\n\r\nNaming things is hard™ – any thoughts?"},"comment":{"url":"https://api.github.com/repos/hoodiehq/pouchdb-hoodie-local-changes/issues/comments/118434227","html_url":"https://github.com/hoodiehq/pouchdb-hoodie-local-changes/issues/4#issuecomment-118434227","issue_url":"https://api.github.com/repos/hoodiehq/pouchdb-hoodie-local-changes/issues/4","id":118434227,"user":{"login":"janl","id":11321,"avatar_url":"https://avatars.githubusercontent.com/u/11321?v=3","gravatar_id":"","url":"https://api.github.com/users/janl","html_url":"https://github.com/janl","followers_url":"https://api.github.com/users/janl/followers","following_url":"https://api.github.com/users/janl/following{/other_user}","gists_url":"https://api.github.com/users/janl/gists{/gist_id}","starred_url":"https://api.github.com/users/janl/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/janl/subscriptions","organizations_url":"https://api.github.com/users/janl/orgs","repos_url":"https://api.github.com/users/janl/repos","events_url":"https://api.github.com/users/janl/events{/privacy}","received_events_url":"https://api.github.com/users/janl/received_events","type":"User","site_admin":false},"created_at":"2015-07-03T22:20:27Z","updated_at":"2015-07-03T22:20:27Z","body":"> This is not exactly what I ment... It doesn't give back the changedDocs from remote, does it? :) Maybe my insight in here, isn't as deep as it should be.\r\n\r\nNOW I think I get your point. Finally, thanks :)\r\n\r\nOk, I will have to think about this for a while :D\r\n"}}