nuxt-community/localforage-module

Name: localforage-module

Owner: Nuxt Community

Description: Localforage module for Nuxt.js

Created: 2018-02-21 09:18:50.0

Updated: 2018-05-02 04:13:35.0

Pushed: 2018-02-21 15:18:25.0

Homepage: null

Size: 134

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

localforage

Setup

• Add @nuxtjs/localforage dependency using yarn or npm to your project
• Add @nuxtjs/localforage to modules section of nuxt.config.js

dules: [
// Simple usage
'@nuxtjs/localforage'

Options

nuxt.config.js

 You can pass options in modules
dules: [
// With options
['@nuxtjs/localforage', {
  driver      : localforage.WEBSQL, // Force WebSQL; same as using setDriver()
  name        : 'myApp',
  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 localforage object
calforage: {
driver      : localforage.WEBSQL, // Force WebSQL; same as using setDriver()
name        : 'myApp',
version     : 1.0,
size        : 4980736, // Size of database, in bytes. WebSQL-only for now.
storeName   : 'keyvaluepairs', // Should be alphanumeric, with underscores.
description : 'some description'

driver

The preferred driver(s) to use. Same format as what is passed to setStorageDriver(), above. Default: [localforage.INDEXEDDB, localforage.WEBSQL, localforage.LOCALSTORAGE]

name

The name of the database. May appear during storage limit prompts. Useful to use the name of your app here. In localStorage, this is used as a key prefix for all keys stored in localStorage. Default: 'localforage'

size

The size of the database in bytes. Used only in WebSQL for now. Default: 4980736

storeName

The name of the datastore. In IndexedDB this is the dataStore, in WebSQL this is the name of the key/value table in the database. Must be alphanumeric, with underscores. Any non-alphanumeric characters will be converted to underscores. Default: 'keyvaluepairs'

version

The version of your database. May be used for upgrades in the future; currently unused. Default: 1.0

description

A description of the database, essentially for developer usage. Default: ''

More informations on LocalForage documentation

Usage

Get item

item = await this.$localForage.getItem(key)

Set item

t this.$localForage.setItem(key, value)

Remove item

t this.$localForage.removeItem(key)

Clear

t this.$localForage.clear

Gets the length

length = await this.$localForage.length

Get the name of a key based on its ID

k = await this.$localForage.key(keyIndex)

Get the list of all keys

keys = await this.$localForage.keys()

Force usage of a particular driver or drivers, if available.

.$localForage.setDriver(localforage.LOCALSTORAGE)

By default, localForage selects backend drivers for the datastore in this order:

1. IndexedDB
2. WebSQL
3. localStorage

If you would like to force usage of a particular driver you can use $setStorageDriver() with one or more of the following parameters.

localforage.INDEXEDDB

localforage.WEBSQL

localforage.LOCALSTORAGE

Development

• Clone this repository
• Install dependnecies using yarn install or npm install
• Start development server using npm run dev

License

MIT License