Firebase SDK 类型定义的 Typescript 函数参数中的可区分联合

时间:2021-02-24 00:39:45

标签: typescript firebase google-cloud-firestore babeljs firebase-admin

你好,亲爱的溢出者,

在客户端和 Firebase Functions 中使用 Firebase 需要两个不同的 sdk,客户端环境中的 firebase-sdk 和云环境中的 firebase-admin-sdk。 https://firebase.google.com/docs/firestore/extend-with-functions

我在云函数和客户端之间共享了功能,例如获取多个集合并从中组装一个文档。 这是必需的,因为在从客户端写入文档时,会触发一个云函数,该函数执行可能需要提取其他文档的额外计算。

这个想法是创建一个可以从双方拉入的公共文件,而没有任何会污染云函数构建或客户端构建的额外依赖项。

为此,理想情况下,我会采用以下模式的类型联合:

import firebase from "firebase";
import admin from "firebase-admin";

export type FirestoreConnection = firebase.firestore.Firestore | admin.firestore.Firestore;
export type FirestoreDocumentReference = firebase.firestore.DocumentReference | admin.firestore.DocumentReference;
export type FirestoreDocumentData = firebase.firestore.DocumentData | admin.firestore.DocumentData;

这将允许我创建这样的函数接口:

getDocument(firestoreConnection: FirestoreConnection, documentUid: string) : FirestoreDocumentData {
...
}

然而,问题是,根据我的理解,通过类型联合将引入两个依赖项,firebase-sdk 作为 firebase-admin-sdk。

据我所知,打字稿中没有预处理器语句。 这将允许我通过删除任一构建的代码来排除其他依赖项:

#if client {
import firebase from "firebase";
} else {
import admin from "firebase-admin";
}
#if client {
export type FirestoreConnection = firebase.firestore.Firestore
...
} else {
export type FirestoreConnection = admin.firestore.Firestore;
...
}

似乎需要手动解决,但这似乎引入了相当多的复杂性,而且似乎与 VSCode 或 WebStorm 等 IDE 不兼容。

创建一个共享函数的正确方法是什么,该函数可以依赖于这两种类型,但只能引入其中之一?

期待想法!

0 个答案:

没有答案