About this CHANGELOG

This file will include all API breakage, new features, and upgrade info in localForage's lifetime.

1.10.0

Avoid uncaught error in dropInstance. You can now catch errors thrown by dropInstance, see #807.

1.9.0

Fixed TypeScript definition for getItem. It now notes that getItem can return null, so this change may cause TypeScript code that didn't account for null values to fail. See #980.

1.8.1

Reverted the ESM/module field change in #940, which broke many builds. See: #979. Sorry about that! 😓

1.8.0

No changes to code, but added a module field in package.json for better ESM support. See: #940.

1.7.4

Use openKeyCursor instead of openCursor for key() retrieval. Props to @MeMark2 for the fix, and thanks to @lincolnthree and @f for additional testing!

1.7.3

Add .npmignore file to reduce package size when installed via npm.

1.6

Add dropInstance() method to localforage.
Improve IDB driver reliability when a connection gets closed.

[1.5.7]

Fix IE8 localStorage support detection.

[1.5.6]

Upgrade lie to 3.1.1 to work with yarn.

[1.5.5]

Roll back dropInstance breaking change.

[1.5.4]

Set null as undefined (for Edge).

[1.5.3]

Check whether localStorage is actually usable.

[1.5.2]

Prevent some unnecessary logs when calling createInstance().

[1.5.1]

Try to re-establish IDB connection after an InvalidStateError.
Added Generics to iterate() TS Typings.
Define custom drivers syncronously when _support isn't a function.
Use the custom driver API for internal drivers, which makes possible to override parts of their implementation.

1.5

Major storage engine change for Safari: We now use IndexedDB as the storage engine for Safari v10.1 (and above). This means that pre-existing Safari >= 10.1 users will experience "data loss" after upgrading your site from a previous version of localForage to v1.5. In fact no data is lost but the engine will change so localForage will seem empty.
- You can use the localForage 1.4 compatibility plugin after the upgrade so that all your Safari users (both old & new) continue to use the WebSQL driver.
- Alternativelly you can force a connection to WebSQL using localForage's config to either keep using your existing WebSQL database or migrate to IndexedDB.

1.4.1

Fixes #520; browserify builds work properly

1.4

Fixes #516; this version should always load the correct driver without that bug.

1.3

We now use ES6 for our source code and webpack to bundle the dist/ files.

1.2

Iterate through the entire database using iterate(). (#283; fixes #186)

1.1

Custom drivers can be created using defineDriver(). (#282; fixes #267)

1.0.3

config() accepts a new option: driver, so users can set the driver during config rather than using setDriver(). (#273; fixes #168)

1.0

It is no longer necessary to queue commands using ready() when using RequireJS. (723cc94e06)
setDriver now accepts an array of drivers to be used, in order of preference, instead of simply a string. The string option is still supported. (eg. now one can use setDriver(['WebSQL', 'localStorage']) instead of setDriver('WebSQL'))
node-style, error-first argument method signatures are used for callbacks. Promises don't use error-first method signatures; instead they supply an error to the promise's reject() function.

This release drops support for some legacy browsers, though not actually the ones you might think. localForage's new policy is to support the current version of all major browsers plus up to three versions back.

Add built versions without the Promises polyfill to dist/ directory. (#172)
Drop support for Firefox 3.5. Minimum version is now Firefox 25. (Technically, Firefox 4+ seems to work.)
Drop support for Chrome 31 and below. Minimum version is now Chrome 32.
Fix a lot of bugs. Especially in Internet Exploder.
Switch to Mocha tests and test on Sauce Labs.
Add a keys() method. (#180)
Check for localStorage instead of assuming it's available. (#183)