localForage adapter for Fortune.js
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
test
.gitignore
LICENSE
README.md
package.json
yarn.lock

README.md

Fortune localForage

npm Version License

donate patreon paypal

This is an adapter for Fortune.js that uses localForage which wraps IndexedDB, WebSQL, or localStorage. There is also a Cordova SQLite Driver.

$ npm install localforage fortune-localforage

Usage

This module works in web browsers only

const fortune = require('fortune')
const localForageAdapter = require('fortune-localforage')

const localForage = require('localforage') 

const store = fortune(recordTypes, {
  adapter: [localForageAdapter, {
      // Name of the IndexedDB database to use. Defaults to `fortune`.
      name: 'fortune',      
      // localforage config
      config: {
        // allowed drivers and priority, same as using driver
        driver: [localforage.INDEXEDDB, localforage.WEBSQL, localforage.LOCALSTORAGE],
        version     : 1.0,
        size        : 4980736, // Size of database, in bytes. WebSQL-only for now.
        storeName   : 'keyvaluepairs', // Should be alphanumeric, with underscores.
        description : 'some description'
      }
      // or just send driver
      driver: [localforage.INDEXEDDB, localforage.WEBSQL, localforage.LOCALSTORAGE],
    }]
})

GraphQL

If you want to use GraphQL to query and mutate data (such as with a matching server schema) check out [GraphQL Genie](https://github.com/genie-team/graphql-genie

License

This software is licensed under the MIT license.

Contribute or Donate

  • Code Contributions
    • Fork
    • Make Changes
    • Run the following and make sure no failures or errors
      • npm run test
      • npm run lint
      • npm run build
    • Open pull request
  • Donate
    • genie-team products are outcomes of a hobby and receive no other funding, any and all support would be greatly appreciated if you find Genie products useful. Your support will encourage faster development of bug fixes, new features and new products.
    • donate (preferred)
    • patreon
    • paypal