gcloud部署的Firestore触发器：event与context的类型及TS定义查询

类型与依赖包 #

• event对象类型：FirestoreEvent<T>，其中T是你业务对应的文档数据类型（可自定义接口）。
• context对象类型：Context。
• 来源npm包：这些类型均来自@google-cloud/functions-framework，需安装为开发依赖。

安装命令 #

npm install --save-dev @google-cloud/functions-framework

示例代码 #

import type { FirestoreEvent, Context } from '@google-cloud/functions-framework';

// 自定义文档数据类型
interface UserData {
  username: string;
  email: string;
}

export const onUserDocumentChange = (
  event: FirestoreEvent<UserData>,
  context: Context
) => {
  // 获取变更前后的文档数据
  const previousDocument = event.data?.oldValue;
  const currentDocument = event.data?.value;
  
  // 获取触发器元数据
  const documentPath = context.resource;
  const triggerTime = context.timestamp;

  // 业务逻辑处理
  console.log(`Document ${documentPath} changed at ${triggerTime}`);
};

额外说明 #

• FirestoreEvent中的data字段包含oldValue（变更前状态）和value（变更后状态），若触发器配置了路径通配符，还可通过event.params获取匹配参数。
• Context提供了触发时间、资源路径等基础元数据。

内容的提问来源于stack exchange，提问作者Alexey Inkin