pouchdb-sapper
v7.2.2-alpha0.0.7
Published
PouchDB-Sapper is a PouchDB adaptation for Sapper.
Downloads
6
Maintainers
Readme
pouchdb-sapper
PouchDB-Sapper is a PouchDB adaptation for Sapper.
Prerequisite
It works with the Svelte/Sapeur/Rollup combination, but not only with Svelte.
A version for Svelte should coming soon.
sapper-template-rollup is a good start.
npx degit "sveltejs/sapper-template#rollup" pouchdb-with-sapper
cd pouchdb-with-sapper
npm install
Usage
1. PouchDB-Sapper install
npm install pouchdb-sapper
// src/routes/_layout.svelte
import PouchDB from 'pouchdb-sapper';
(() => {
if(typeof process !== 'undefined') return; // sapper stops here
const testDB = new PouchDB('test');
})();
Notes:
- You can put this script in any .svelte file in your app.
- It is really important to block Sapper in this script. Because SSR will try to run pouchdb-sapper (pouchdb-browser) and attempt to create the LevelDB database on the server. This is not a good thing for two reasons:
- The LevelDB adapter is not present in the pouchdb-browser vanilla.
- If you want to run a LevelDB database on your server (polka / express), it is better to use pouchdb or pouchdb-node.
You could use pouchdb-sapper for the Front and pouchdb for the Back.
2. You have to install rollup-plugin-node-polyfills
npm install --save-dev rollup-plugin-node-polyfills
//rollup.config.js
import nodePolyfills from 'rollup-plugin-node-polyfills';
export default {
client: {
plugins: [
nodePolyfills(),
]
}
}
//not in the server nor in the serviceworker
3. Run it
npm run dev
Open localhost in your browser.
Debug mode > Application > Storage > IndexedDB > _pouch_test
Why don't use onMount ?
Example:
We have two .svelte files.
- parent.svelte
- Child.svelte
Child.svelte is a component of parent.svelte.
In these two files there is an onMount function.
The svelte runtime will trigger Child.svelte onMount at the first time, then parent.svelte onMount at the second time.
This is a problem if you create a pouchdb instance in parent.svelte and if you want to use it in Child.svelte.
With pouch-sapper you don't have to use onMount and so you can create a single instance that can be passed to components.
API PouchDB
For full API documentation and guides on PouchDB, see PouchDB.com.