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

indexeddbstore

v0.1.0

Published

Promise based client-side wrapper for HTML5 IndexedDB in the browser.

Downloads

29

Readme

IndexedDB Data Storage Module

Promise based client-side wrapper for HTML5 IndexedDB in the browser, built with Browserify.

API

IndexedDBStore is built according to CommonJS principles. Thus the module is able to be imported in the browser using Browserify and the common require() function. Else, window.IndexedDBStore is available.

var IndexedDBStore = require('indexeddbstore')

var Store = new IndexedDBStore({
	dbName: "DEFAULT",	// String
	stores: ['store']	 // Array with store names to create
})

Store.save(Object|Array).then(function(guid) {
	console.log("GUID: ", guid)
	// => String|Array
})

Store.save(Object, "existing-guid").then(function(guid) {
	console.log("GUID: ", guid)
	// => String "existing-guid"
})

Store.create(Object).then(function(record) {
	console.log("Record: ", record)
	// => Object {data: Object, guid: String}
})

// ... Store#create supports the same method signatures as Store#save

Store.get("guid").then(function(record) {
	console.log("Record: ", record)
	// => Object {data: Object, guid: String}
})

Store.get( ["guid1", "guid2"] ).then(function(records) {
	console.log("Records: ", records)
	// => Array [ {data: {foo: "bar"}, guid: String guid1}, {data: {foo: "bar"}, guid: String guid2} ]
})

Store.all().then(function(records) {
	console.log("Records: ", records)
	// => Array
})

Store.size().then(function(size) {
	console.log("Size: ", size)
	// => Number
})

Store.clear().then(function() {
	console.log("Cleared store")
	// Post-con: Store#size() === 0
})

Store.use('store-name').save( ... )
// Returns the same instance but will operate on the specified store name.
// Will remember the store for next operation.

All methods returns a Promise, except for Store#use.

Build tasks

Gulp is used for build tasks. Be sure to run npm install to install all dependencies.

# Default: builds bundle.js from lib/IndexedDBStore.js
gulp
gulp build

# Watches lib/IndexedDBStore.js for changes and generates a build
gulp watch

# Removes `build`
gulp clean

Develop

You have to have a watch task running in order to let Browserify build a concatenated file will all dependencies.

npm install
gulp watch

A task for building files ready for distribution is available:

gulp dist

This will create files dist/indexeddbstore.js and dist/indexeddbstore.min.js.

A concatenated bundle.js will be generated in the build directory.

Tests

Tests reside in the test/tests.js file, and uses Mocha and Chai.js.

gulp test

Visit http://localhost:3000/test/runner.html in your browser to view the Mocha test runner. The gulp test task will start a static Connect file server and re-build the main and test files when any of their sources are edited (e.g. the build/bundle.js and test/bundle-test.js files will be re-built on save).

Thanks to Browserify, the tests are using require() to import the library files, including utils.js. The following task will build the test bundle used in the test runner HTML file:

gulp build-test

This is automatically called in gulp test.

Tests run in a browser window for now, since headless browsers like PhantomJS don't support the IndexedDB API yet (as of PhantomJS 1.9).

License

MIT.