@google-cloud/connect-firestore

中文文档
3.0.0发布于 2023/12/05Apache-2.0TypeScriptCommonJS零依赖近 30 天下载 7.2万

Google Cloud Firestore session store for Express/Connect

此软件包已被标记为弃用

package no longer maintained

原始使用文档
文档目录9 节
  1. Quickstart
  2. Before you begin
  3. Installing the client library
  4. Using the client library
  5. Samples
  6. Supported Node.js Versions
  7. Versioning
  8. Contributing
  9. License

Google Cloud Platform logo

Google Cloud Firestore Session

release level npm version

An express session store backed by Google Cloud Firestore.

@google-cloud/connect-firestore is an express session store backed by Google Cloud Firestore.

Note: Cloud Firestore is a persistent, distributed, transactional database. Often, it's more appropriate to choose a different storage solution for sessions such as Memcache or Redis as their designs offer much faster operation in this use case.

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable the Google Cloud Firestore Session API.
  3. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/connect-firestore

Using the client library

const {Firestore} = require('@google-cloud/firestore');
const express = require('express');
const session = require('express-session');
const app = express();

const {FirestoreStore} = require('@google-cloud/connect-firestore');

app.use(
  session({
    store: new FirestoreStore({
      dataset: new Firestore(),
      kind: 'express-sessions',
    }),
    secret: 'my-secret',
    resave: false,
    saveUninitialized: true,
  })
);

app.get('/', (req, res) => {
  if (!req.session.views) {
    req.session.views = 0;
  }
  const views = req.session.views++;
  res.send(`Views ${views}`);
});

app.listen(4830, () => {
  console.log('Example app listening on port 4830!');
});

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

SampleSource CodeTry it
Quickstartsource codeOpen in Cloud Shell

The Google Cloud Firestore Session Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/connect-firestore@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

License

Apache Version 2.0

See LICENSE

版本与发布记录

@google-cloud/connect-firestore 共发布 11 个版本,首次发布于 2019/05/22;过去 12 个月发布了 0 个版本。

版本发布日期距今
3.0.0latest2023/12/052 年前
2.0.2legacy-102021/08/265 年前
2.0.12020/12/035 年前
2.0.02020/11/036 年前
1.0.6legacy-82020/01/036 年前
1.0.52019/12/066 年前

关于 @google-cloud/connect-firestore 的常见问题

@google-cloud/connect-firestore 是什么?

Google Cloud Firestore session store for Express/Connect注意:该包已被作者标记为弃用——package no longer maintained

如何安装 @google-cloud/connect-firestore?

在项目目录运行 npm install @google-cloud/connect-firestore,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@google-cloud/firestore(^7.1.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@google-cloud/connect-firestore 支持 TypeScript 吗?

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

@google-cloud/connect-firestore 支持 ESM 还是 CommonJS?

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

@google-cloud/connect-firestore 需要什么版本的 Node.js?

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

@google-cloud/connect-firestore 可以商用吗?

@google-cloud/connect-firestore 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@google-cloud/connect-firestore 的下载量有多少?

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

@google-cloud/connect-firestore 还在维护吗?

最新版本 3.0.0 发布于 2023/12/05(2 年前);至今共发布 11 个版本,其中过去 12 个月发布了 0 个;首次发布于 2019/05/22。作者已将其标记为弃用,新项目建议寻找替代方案。