localForage
是一个用于前端存储的库,它提供了一个简单的 API 来存储数据,并自动选择最佳的存储机制(IndexedDB、WebSQL 或 LocalStorage)。以下是 localForage
的基本使用方法。
安装
首先,你需要安装 localForage
。可以使用 npm 或 yarn:
npm install localforage
或
yarn add localforage
基本用法
以下是 localForage
的基本用法示例:
import localforage from 'localforage';
// 设置配置(可选)
localforage.config({
driver: localforage.INDEXEDDB, // 使用 IndexedDB
name: 'myApp', // 数据库名称
version: 1.0, // 数据库版本
storeName: 'keyvaluepairs', // 存储名称
description: 'Some description'
});
// 存储数据
localforage.setItem('key', 'value')
.then(() => {
console.log('数据已存储');
})
.catch(err => {
console.error('存储数据时出错:', err);
});
// 获取数据
localforage.getItem('key')
.then(value => {
console.log('获取的数据:', value);
})
.catch(err => {
console.error('获取数据时出错:', err);
});
// 删除数据
localforage.removeItem('key')
.then(() => {
console.log('数据已删除');
})
.catch(err => {
console.error('删除数据时出错:', err);
});
// 清空所有数据
localforage.clear()
.then(() => {
console.log('所有数据已清空');
})
.catch(err => {
console.error('清空数据时出错:', err);
});
// 存储对象
const user = { name: 'Alice', age: 25 };
localforage.setItem('user', user)
.then(() => {
console.log('用户数据已存储');
})
.catch(err => {
console.error('存储用户数据时出错:', err);
});
// 获取对象
localforage.getItem('user')
.then(user => {
console.log('获取的用户数据:', user);
})
.catch(err => {
console.error('获取用户数据时出错:', err);
});
主要方法
- setItem(key, value): 存储数据,
key
是存储的键,value
是存储的值。 - getItem(key): 获取存储的数据,返回一个 Promise。
- removeItem(key): 删除指定键的数据。
- clear(): 清空所有存储的数据。
- length(): 获取存储的项数。
- key(index): 获取指定索引的键。
注意事项
localForage
会自动选择最佳的存储机制,通常是 IndexedDB,但可以通过配置强制使用特定的存储机制。localForage
支持 Promise API,方便与现代 JavaScript 代码结合使用。- 由于
localForage
是基于异步操作的,确保在使用时处理好 Promise 的返回值。
通过使用 localForage
,你可以轻松地在前端应用中实现持久化存储,支持多种数据类型和存储机制。