npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

localforage-indexes

v1.1.1

Published

plugin for localforage to work with indexes in indexedDb

Downloads

7,916

Readme

localforage-indexes

Plugin for localforage to work with indexes in indexedDb localForage.

Requirements

Installation

npm i localforage-indexes

API

createIndex

createIndex(indexName, keyPath[, options[, callback]])

Creates an index on the specified storage Supports promises and callbacks

Promise case:

localforage.createIndex('LF_INDEX', 'INDEXED_FIELD')
.then((index) => {
  // index created
})
.catch((err) => {
  //...
});

Callback case:

localforage.createIndex('LF_INDEX', 'INDEXED_FIELD', (err, index) => {
  // check error here
});

getIndex

getIndex(indexName[, callback])

Updates existing index on the specified storage Supports promises and callbacks

Promise case:

localforage.getIndex('LF_INDEX')
.then(() => {
  // index deleted
})
.catch((err) => {
  //...
});

Callback case:

localforage.getIndex('LF_INDEX', (err, index) => {
  // check error here
})

updateIndex

updateIndex(indexName, keyPath[, options[, callback]])

Updates existing index on the specified storage Used to change keyPath or options of an index Supports promises and callbacks

Promise case:

localforage.updateIndex('LF_INDEX', 'ANOTHER_INDEXED_FIELD')
.then((index) => {
  // index updated
})
.catch((err) => {
  //...
});

Callback case:

localforage.updateIndex('LF_INDEX', 'ANOTHER_INDEXED_FIELD', (err, index) => {
  // check error here
});

deleteIndex

deleteIndex(indexName[, callback])

Updates existing index on the specified storage Supports promises and callbacks

Promise case:

localforage.deleteIndex('LF_INDEX')
.then(() => {
  // index deleted
})
.catch((err) => {
  //...
});

Callback case:

localforage.deleteIndex('LF_INDEX', (err, index) => {
  // check error here
})

Methods' arguments

Arguments are the same as of vanilla indexedDb API Details

indexName - index name, must be unique for the store keyPath - path of the field that index is based upon, separated by dot: EXAMPLE.KEY.PATH options:

  • multiEntry - will make an effect if keyPath resolves to an array. If true multiple index entry will be created for each array element, if false single instance is created. Default: false
  • unique - if set to true removes duplicates from index. Default: false callback - Callback function. If one is provided method call won't return a promise. Instead a callback will be called when the indexedDB transaction is finished.

Usage

Warning: Firefox and Safari do not support usage of Promises with indexedDB's transactions

Any transaction passed through native promise will get destroyed. Firefox/Safari transactions can still be used with callbacks.

Intended to use only with indexedDb. Custom driver to be compatible with indexes must inherit from localforage's indexdDb(asyncStorage) driver.

import {extendPrototypeResult as localforage} from 'localforage-indexes';

localforage.createIndex('LF_INDEX', 'INDEXED_FIELD')
.then((index) => {
  // working with index...
})

Can be used with a single instance of localforage for each indexDb database.

import {extendPrototypeResult as localforage} from 'localforage-indexes';

var forage = localforage.createInstance({
  driver      : 'asyncStorage',
  name        : 'multiInstance',
  storeName   : 'multiInstanceStore'
});

var another_forage = localforage.createInstance({
  driver      : 'asyncStorage',
  name        : 'multiInstance',
  storeName   : 'anotherMultiInstanceStore'
});

forage.createIndex('newIndex', 'KEYPATH')
.then(() => {
  // will most likely cause an error because of conflicting db
  // versions
  another_forage.createIndex('anotherIndex');
});

Links