@feathersjs-offline/localforage

中文文档
1.1.1发布于 2021/11/19MITTypeScriptCommonJS近 30 天下载 3407

基于本地文件的 FeathersJS 客户端侧服务, 持续到索引数据库、 WebSQL 或 localStorage

中文使用文档
文档目录6 节
  1. API 密码
  2. service(options)
  3. 仓库、打字台和其他联署材料物件
  4. 示例
  5. 浏览器
  6. 许可证

@ feathersjs-offline/ 本地福建

npm version Build Status Known Vulnerabilities Maintainability Test Coverage Download Status

@ featherjs-offline/ 本地福建 是一个数据库服务适配器包 localForage 坚持其中之一 IndexedDB, (中文(简体) ), WebSQL,或 LocalStorage 使得它对于移动和离线第一应用程序非常有用,具有额外能力来无缝地处理Blobs,TypedArrays等JS对象.

$ npm install --save @feathersjs-offline/localforage

重要内容: @feathersjs-offline/localforage 执行 Feathers 常见数据库适配器 API 财务报告和审定财务报表 查询语法。 。 。 .

API 密码

service(options)

返回已初始化的新服务实例.

const service = require('@feathersjs-offline/localforage');

app.use('/messages', service({
  storage: ['IndexedDB', 'localStorage']
}));
app.use('/messages', service({ storage, id, startId, name, store, paginate }));

选项 :

  • storage (单位:千美元)选项,默认值 : 'INDEXEDDB') - 存储后端. 一定是一个或一个以上 'INDEXEDDB', (中文(简体) ), 'WEBSQL',或 'LOCALSTORAGE'。如果在实际设备上不支持所需的存储类型,适配器将使用与倒置相同的序列。 或者,您可以提供一系列决定您选择的优先级的存储后端 .
  • version (单位:千美元)选项,默认值 : 1.0) - (英语) localforage 要使用的驱动程序版本 。 目前仅 1.0 已存在.
  • size (单位:千美元)选项默认值 4980736) - 所需的最大数据库大小。 默认 DB 大小为 刚刚下 5MB,因为它是任何浏览器中无需提示即可使用的最高尺寸.
  • id (单位:千美元)选项,默认值 : 'id') - id字段地产名称.
  • name (单位:千美元)选项,默认值 : 'feathers') - 将数据存储在本地或自动存储中的关键.
  • store (单位:千美元)选项) - 有 ID 项任务以预初始化数据存储的对象.
  • dates (单位:千美元)选项默认值 false) - 将ISO格式化的日期字符串转换为 Date 结果集中的对象.
  • events (单位:千美元)选项- 清单 自定义服务事件 本服务发送.
  • paginate (单位:千美元)选项) - A类 标记对象 包含一个 default 财务报告和审定财务报表 max 页面大小.
  • whitelist (单位:千美元)选项) - 可允许的附加查询参数列表.
  • multi (单位:千美元)选项- 允许 create 带有数组和 update 财务报告和审定财务报表 remove 与 id null 以更改多个项目。 可能会 true 所有方法或允许的一系列方法(例如:. [ 'remove', 'create' ]) (中文(简体) ).
  • reuseKeys (单位:千美元)选项,默认值 : false)允许重复键(参见 name),即最后定义胜出. 主要用于示范和测试目的.

仓库、打字台和其他联署材料物件

由于这是一项执行,除此之外 localForage 您可以存储任意类型 @feathersjs-offline/localforage;你并不局限于像在 localStorage。即使 localStorage 是您的存储后端, @feathersjs-offline/localforage jSON.parse () 和 JSON. stringify () 在获取/设定值时自动执行 .

feathers-localforage 支持存储所有可以被序列化为JSON的原生JS对象,以及ArrayBuffers, Blobs,和TypedArrays. 检查 本地格式 API 文档 对于支持的完整类型列表。 此外,设置选项 dates 改为 true 将确定结果中任何 ISO 格式化的日期实际上是日期对象而不是文本字符串.

每个存储后端都支持所有类型,尽管存储限制在 localStorage 使得许多大型Blobs的存储成为不可能.

我们默认 indexedDB 如果可以的话,倒数 localStorage 作为最后的手段.

示例

见 客户 关于浏览器和React Industrial中使用Feathers的更多信息的章节.

浏览器

<script type="text/javascript" src="//unpkg.com/@feathersjs/client@^4.5.11/dist/feathers.js"></script>
<script type="text/javascript" src="//unpkg.com/@feathersjs-offline/localforage@^1.0.0/dist/localforage.js"></script>
<script type="text/javascript">
  var service = feathersjsOfflineLocalforage.init({
    storage: ['indexeddb', 'websql', 'localStorage']
  });
  var app = feathers().use('/messages', service);

  var messages = app.service('messages');

  messages.on('created', function(message) {
    console.log('Someone created a message', message);
  });

  messages.create({
    text: 'Message created in browser'
  });
</script>

许可证

版权 (c) 由 Feathers 创作 2021

凭 麻省理工学院许可证。 。 。 .

版本与发布记录

@feathersjs-offline/localforage 共发布 6 个版本,首次发布于 2021/10/23;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.1.1latest2021/11/194 年前
1.0.42021/10/285 年前
1.0.32021/10/265 年前
1.0.22021/10/265 年前
1.0.12021/10/255 年前
1.0.02021/10/235 年前

关于 @feathersjs-offline/localforage 的常见问题

@feathersjs-offline/localforage 是什么?

基于本地文件的 FeathersJS 客户端侧服务, 持续到索引数据库、 WebSQL 或 localStorage

如何安装 @feathersjs-offline/localforage?

在项目目录运行 npm install @feathersjs-offline/localforage,或使用 pnpm add / yarn add / bun add。

@feathersjs-offline/localforage 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@feathersjs-offline/localforage 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@feathersjs-offline/localforage 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >= 12。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@feathersjs-offline/localforage 可以商用吗?

@feathersjs-offline/localforage 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@feathersjs-offline/localforage 的下载量有多少?

根据 npm 官方下载统计,@feathersjs-offline/localforage 在 2026/10/15 – 2026/11/13 这 30 天内被下载 3,407 次,日均约 114 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@feathersjs-offline/localforage 还在维护吗?

最新版本 1.1.1 发布于 2021/11/19(4 年前);至今共发布 6 个版本,其中过去 12 个月发布了 0 个;首次发布于 2021/10/23。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。