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

README fixes

Browse Source
This commit is contained in:
Timothy Farrell 2018-08-22 10:32:40 -05:00
parent a2cd9284f7
commit a2aa65bba1
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -7,18 +7,23 @@ 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 sentry blob to be saved in the pouchdb document. 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
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
to be proxied.
When an attachment is requested, the sentry blob will be provided to a custom `getFn` function to be When an attachment is requested, the document attached blob (returned from `save`) will be provided
converted into desired document. to a custom `getFn` function to be converted into desired document. `blobToString` is provided to
make this easier for simple string identifier cases.
Similar to `getFn`, the sentry blob is provided to `remove` when an attachment or its containing Similar to `getFn`, the sentry blob is provided to `remove` when an attachment or its containing
document is deleted. document is deleted.
Each function is expected to be asynchronous and the database will not continue its operation until Each function is expected to be asynchronous and the database will not continue its operation until
the proxy function completes to ensure data integrity. It may be desirable to for the `remove` the proxy function completes to ensure data integrity. It may be desirable to for the `remove`
function to delay attachment cleanup. The proxy blob will be removed from document (effectively function to delay attachment cleanup. In this case, the document blob will be removed from document
orphaning the proxied attachment until it is cleaned). (effectively orphaning the proxied attachment until it is cleaned asynchronously).
## Example ## Example