explorigin/pouchdb-attachmentproxy
Archived
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Upgrade Lerna and require prettier. Some format changes

Browse Source
This commit is contained in:
Timothy Farrell 2018-08-22 15:22:59 -05:00
parent a2aa65bba1
commit 0e99014b45
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
packages/pouchdb-attachmentproxy/README.md
View File

@ -7,10 +7,10 @@ metadata without having the raw data bogging down your PouchDB database.
## Overview ## Overview
Attachment Proxy works by intercepting attachments bound for the pouchdb backend and passing them to Attachment Proxy works by intercepting attachments bound for the pouchdb backend and passing them to
a custom `save` function that will return a blob to be saved in the pouchdb document. The returned a custom `save` function that will return a blob to be saved in the pouchdb document. The returned
blob should be a smaller *sentry* blob with just enough information needed to fetch the full version blob should be a smaller _sentry_ blob with just enough information needed to fetch the full version
that is being proxied. `stringToBlob` is provided to make this process easier for simple string that is being proxied. `stringToBlob` is provided to make this process easier for simple string
identifier cases. Alternatively, you can pass the original attachment through if you do not want it identifier cases. Alternatively, you can pass the original attachment through if you do not want it
to be proxied. to be proxied.
When an attachment is requested, the document attached blob (returned from `save`) will be provided When an attachment is requested, the document attached blob (returned from `save`) will be provided