npm 包 sky-firestore 使用教程

简介

sky-firestore 是一个基于 Firestore 的封装库，它简化了 Firestore 的使用。 sky-firestore 提供了一些方便的方法，让我们可以更快速地进行读写操作，以及实时监控数据的变化。

安装

你可以通过 npm 安装 sky-firestore。在终端中运行以下命令：

npm install sky-firestore

使用

在你的项目中引入 sky-firestore，在初始化时需要传入 Firebase 的配置信息：

import SkyFirestore from "sky-firestore";
import firebaseConfig from "./firebase-config.js";

const sf = new SkyFirestore(firebaseConfig);

sky-firestore 中有两个重要的类：SkyFirestore 和 SkyDocumentReference，其中 SkyFirestore 是连接 Firestore 的入口，而 SkyDocumentReference 则是代表一个 Document 的引用。

读取数据

一般来说，我们会使用 get 方法来读取数据。可以通过 doc 方法获取一个 SkyDocumentReference，从而进行数据的读取。

sf.doc("users/123").get().then((doc) => {
  if (doc.exists) {
    console.log(doc.data());
  }
});

写入数据

可以通过 set 方法将数据保存到 Firestore：

sf.doc("users/123").set({
  name: "Jack",
  age: 18
});

更新数据

使用 update 方法可以局部更新一条记录：

sf.doc("users/123").update({
  name: "Tom"
});

监听数据变化

使用 onSnapshot 可以实时监控数据的变化：

sf.doc("users/123").onSnapshot((doc) => {
  console.log(doc.data());
});

总结

sky-firestore 是一个方便的封装库，它可以大大简化我们在使用 Firestore 进行数据读写和实时监控时的开发工作。将其统一起来的好处是我们不需要在每个项目中编写基础代码，而是可以在一个库中进行定义和重用这些代码，提高代码的重用性，加快项目的开发速度。

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