npm 包 gistore 使用教程

什么是 gistore？

Gistore 是一款基于 localforage 的简单而实用的本地存储库。它允许您以键值对的形式存储和检索数据，还具有一些高级功能，例如事务，过期和缓存清除。

如何安装和使用 gistore？

安装

您可以使用 npm 进行安装：

npm install --save gistore

导入

在您的项目中，导入 gistore：

import Gistore from 'gistore';

您也可以在 HTML 文件中使用 script 标签：

<script src="node_modules/gistore/dist/gistore.min.js"></script>

创建实例

要使用 gistore，您需要先创建一个实例。在大多数情况下，您只需要一个实例，因此建议将其作为单例进行存储：

const gistore = new Gistore({
  name: 'myDbName',
  storeName: 'myStoreName'
});

在这里，您定义了一个名为 myDbName 的数据库和一个名为 myStoreName 的存储区。您可以使用这些值来检索和存储数据。如果您在不同的存储区中存储数据，请创建多个实例。

存储和检索数据

存储数据的方法是 setItem，检索数据的方法是 getItem。这些方法都是异步的，并返回一个 Promise。例如：

gistore.setItem('myKey', 'myValue').then(() => {
  gistore.getItem('myKey').then(value => console.log(value));
});

这将在存储区中存储一个键值对，并在控制台中打印出 'myValue'。请注意，在调用 setItem 之前可能需要等待 gistore 初始化，否则您可能会遇到一些令人困惑的问题。您可以使用 ready 方法来等待初始化完成：

gistore.ready().then(() => {
  gistore.setItem('myKey', 'myValue').then(() => {
    gistore.getItem('myKey').then(value => console.log(value));
  });
});

过期

如果您想让存储的数据在一段时间后过期并自动删除，可以使用 expire 选项。例如：

const gistore = new Gistore({
  name: 'myDbName',
  storeName: 'myStoreName',
  expire: {
    myKey: 600 // 10 minutes
  }
});

这将在 10 分钟后自动删除名为 'myKey' 的键值对。通过指定其他时间，您可以为每个键设置不同的过期时间。

清除缓存

如果您想清除缓存，可以使用 clear 方法：

gistore.clear().then(() => console.log('Cache cleared!'));

这将清除缓存中的所有数据。

示例代码

以下是一个完整的示例代码，它使用 gistore 存储和检索数据：

-- -------------------- ---- -------
------ ------- ---- ----------

----- ------- - --- ---------
  ----- -----------
  ---------- -------------
---

----------------------- -- -
  ------------------------ ------------------ -- -
    ----------------------------------- -- --------------------
  ---
---

结论

Gistore 是一个强大而易于使用的本地存储库，可以轻松地在您的项目中使用。它提供了许多高级功能，例如事务，过期和缓存清除，使其成为一个非常有用的工具。希望这篇文章能够帮助您了解如何在您的项目中使用 gistore。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60065f76238a385564ab68da