| 1 | # About this CHANGELOG
|
| 2 |
|
| 3 | This file will include all API breakage, new features, and upgrade info in
|
| 4 | localForage's lifetime.
|
| 5 |
|
| 6 | ### [1.5.3]
|
| 7 |
|
| 8 | * Check whether localStorage is actually usable.
|
| 9 |
|
| 10 | ### [1.5.2]
|
| 11 |
|
| 12 | * Prevent some unnecessary logs when calling `createInstance()`.
|
| 13 |
|
| 14 | ### [1.5.1]
|
| 15 |
|
| 16 | * Try to re-establish IDB connection after an InvalidStateError.
|
| 17 | * Added Generics to `iterate()` TS Typings.
|
| 18 | * Define custom drivers syncronously when `_support` isn't a function.
|
| 19 | * Use the custom driver API for internal drivers, which makes possible to override parts of their implementation.
|
| 20 |
|
| 21 | ### [1.5](https://github.com/mozilla/localForage/releases/tag/1.5.0)
|
| 22 | * **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.
|
| 23 | * You can use the [localForage 1.4 compatibility plugin](https://github.com/localForage/localForage-compatibility-1-4) after the upgrade so that all your Safari users (both old & new) continue to use the WebSQL driver.
|
| 24 | * Alternativelly you can force a connection to WebSQL using [localForage's config](https://localforage.github.io/localForage/#settings-api-setdriver) to either keep using your existing WebSQL database or migrate to IndexedDB.
|
| 25 |
|
| 26 | ### [1.4.2](https://github.com/mozilla/localForage/releases/tag/1.4.2)
|
| 27 | * Fixes #562.
|
| 28 |
|
| 29 | ### [1.4.1](https://github.com/mozilla/localForage/releases/tag/1.4.1)
|
| 30 | * Fixes #520; browserify builds work properly
|
| 31 |
|
| 32 | ### [1.4](https://github.com/mozilla/localForage/releases/tag/1.4.0)
|
| 33 | * Fixes #516; this version should always load the correct driver without that bug.
|
| 34 |
|
| 35 | ### [1.3](https://github.com/mozilla/localForage/releases/tag/1.3.0)
|
| 36 | * We now use ES6 for our source code and `webpack` to bundle the `dist/` files.
|
| 37 |
|
| 38 | ### [1.2](https://github.com/mozilla/localForage/releases/tag/1.2.0)
|
| 39 | * Iterate through the entire database using `iterate()`. ([#283](https://github.com/mozilla/localForage/pull/283); fixes [#186](https://github.com/mozilla/localForage/pull/186))
|
| 40 |
|
| 41 | ### [1.1](https://github.com/mozilla/localForage/releases/tag/1.1.0)
|
| 42 | * Custom drivers can be created using `defineDriver()`. ([#282](https://github.com/mozilla/localForage/pull/282); fixes [#267](https://github.com/mozilla/localForage/pull/267))
|
| 43 |
|
| 44 | ### [1.0.3](https://github.com/mozilla/localForage/releases/tag/1.0.3)
|
| 45 | * `config()` accepts a new option: `driver`, so users can set the driver during config rather than using `setDriver()`. ([#273](https://github.com/mozilla/localForage/pull/273); fixes [#168](https://github.com/mozilla/localForage/pull/168))
|
| 46 |
|
| 47 | ### [1.0](https://github.com/mozilla/localForage/releases/tag/1.0.0)
|
| 48 |
|
| 49 | * It is no longer necessary to queue commands using `ready()` when using RequireJS. ([723cc94e06](https://github.com/mozilla/localForage/commit/723cc94e06af4f5ba4c53fa65524ccd5f6c4432e))
|
| 50 | * `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')`)
|
| 51 | * 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.
|
| 52 |
|
| 53 | ### [0.9](https://github.com/mozilla/localForage/releases/tag/0.9.1)
|
| 54 |
|
| 55 | This release drops support for some legacy browsers, though not actually the
|
| 56 | ones you might think. localForage's new policy is to support the current
|
| 57 | version of all major browsers plus up to three versions back.
|
| 58 |
|
| 59 | * Add built versions without the Promises polyfill to `dist/` directory. ([#172](https://github.com/mozilla/localForage/pull/172))
|
| 60 | * **Drop support for Firefox 3.5. Minimum version is now Firefox 25.** (Technically, Firefox 4+ seems to work.)
|
| 61 | * **Drop support for Chrome 31 and below. Minimum version is now Chrome 32.**
|
| 62 | * Fix a **lot** of bugs. Especially in Internet Exploder.
|
| 63 | * Switch to Mocha tests and test on [Sauce Labs](https://saucelabs.com/).
|
| 64 | * Add a `keys()` method. ([#180](https://github.com/mozilla/localForage/pull/180))
|
| 65 | * Check for localStorage instead of assuming it's available. ([#183](https://github.com/mozilla/localForage/pull/183))
|
| 66 |
|
| 67 | ### [Version 0.8](https://github.com/mozilla/localForage/releases/tag/0.8.1)
|
| 68 |
|
| 69 | * Add support for web workers. ([#144](https://github.com/mozilla/localForage/pull/144), [#147](https://github.com/mozilla/localForage/pull/147)).
|
| 70 |
|
| 71 | ### [Version 0.6.1](https://github.com/mozilla/localForage/releases/tag/0.6.1)
|
| 72 |
|
| 73 | * Put built versions back in `dist/` directory.
|
| 74 |
|
| 75 | ### [Version 0.6.0](https://github.com/mozilla/localForage/releases/tag/0.6.0)
|
| 76 |
|
| 77 | * Add `localforage.config`. ([#40](https://github.com/mozilla/localForage/pull/140))
|
| 78 | * Fix iFrame bug in WebKit. ([#78](https://github.com/mozilla/localForage/issues/78))
|
| 79 | * Improve error handling. ([#60](https://github.com/mozilla/localForage/issues/60))
|
| 80 | * Remove support for `window.localForageConfig`. ([#135](https://github.com/mozilla/localForage/issues/135))
|
| 81 |
|
| 82 | ### [Version 0.4](https://github.com/mozilla/localForage/releases/tag/0.4.0)
|
| 83 |
|
| 84 | * Built versions of localForage are now in the top-level directory. ([2d11c90](https://github.com/mozilla/localForage/commit/2d11c90))
|
| 85 |
|
| 86 | ### [Version 0.3](https://github.com/mozilla/localForage/releases/tag/0.3.0)
|
| 87 |
|
| 88 | * Check code quality in test suite ([#124](https://github.com/mozilla/localForage/pull/124))
|
| 89 | * `_initDriver()` is called after first public API call ([#119](https://github.com/mozilla/localForage/pull/119))
|
| 90 |
|
| 91 | ### [Version 0.2.1](https://github.com/mozilla/localForage/releases/tag/0.2.1)
|
| 92 |
|
| 93 | * Allow configuration of WebSQL DB size ([commit](https://github.com/mozilla/localForage/commit/6e78fff51a23e729206a03e5b750e959d8610f8c))
|
| 94 | * Use bower for JS dependencies instead of `vendor/` folder ([#109](https://github.com/mozilla/localForage/pull/109))
|
| 95 |
|
| 96 | ### [Version 0.2.0](https://github.com/mozilla/localForage/releases/tag/0.2.0)
|
| 97 |
|
| 98 | * Add support for ArrayBuffer, Blob, and TypedArrays ([#54](https://github.com/mozilla/localForage/pull/54), [#73](https://github.com/mozilla/localForage/pull/73))
|
| 99 |
|
| 100 | ### [Version 0.1.1](https://github.com/mozilla/localForage/releases/tag/0.1.1)
|
| 101 |
|
| 102 | * Added config options to allow users to set their own database names, etc. ([#100](https://github.com/mozilla/localForage/pull/100))
|
| 103 |
|
| 104 | ---
|
| 105 |
|
| 106 | ### March 16th, 2014
|
| 107 |
|
| 108 | * Moved Backbone adapter to its own repository ([b7987b3091855379d4908376b668b4b51a6fedfe](https://github.com/mozilla/localForage/commit/b7987b3091855379d4908376b668b4b51a6fedfe))
|
| 109 |
|
| 110 | ### March 13th, 2014
|
| 111 |
|
| 112 | * Changed `localforage.driver` to a function instead of the string directly ([49415145021b0029d2521182de6e338e048fe5b1](https://github.com/mozilla/localForage/commit/49415145021b0029d2521182de6e338e048fe5b1))
|
| 113 |
|
| 114 | ### March 4th, 2014
|
| 115 |
|
| 116 | * Changed the IndexedDB database name from `asyncStorage` to `localforage` ([f4e0156a29969a79005ac27b303d7e321a720fc6](https://github.com/mozilla/localForage/commit/f4e0156a29969a79005ac27b303d7e321a720fc6))
|