Firebaseの型定義がわからない

Question

現在TypeScript+Firebaseの学習を進めていますが、CloudFunctionsで型定義がわからず困っております。

functions/src/index.tsにおいて

import * as functions from 'firebase-functions';
import * as admin from 'firebase-admin';
import * as express from 'express';
import * as postApi from './post';

admin.initializeApp();

const app = express();

app.get('/', (request, response) => {
  postApi.get(admin, request, response);　// このadminの型定義
});

export const post = functions.region('asia-northeast1').https.onRequest(app);

としたものの、adminの型定義がわからない状態です。

firebase-adminのライブラリの中を見ると、admin.app.Appの型定義が返されていたので、そちらで対応したところエラーが出てしまい実現できませんでした。
Argument of type 'typeof import([省略])' is not assignable to parameter of type 'App'
もしこの型定義をご存知の方がいればよろしくお願いいたします。

Answer 1

現在TypeScript+Firebaseの学習を進めていますが、CloudFunctionsで型定義がわからず困っております。

Firebase, TypeScript, Expressの基本的な知識の理解を飛ばしてここで丸投げ質問するというのは 学習 と言えないと思います。

JS
https://ja.javascript.info/

TS
https://typescript-jp.gitbook.io/deep-dive/

Express
https://expressjs.com/ja/

Firebase
https://firebase.google.com/docs?hl=ja

まずはこれら全てに目を通してそれぞれの基本を押さえて下さい。
全てがあやふやな状況で組み合わせて実装していくことはより困難です。

まずはExpressをローカルで動作させる。
それをTypeScript化してみる。
Express+TypeScriptアプリをFirebaseに載せる。
というようなステップを踏んで学習となります。

ちなみにadmin.app.Appの型定義というのは下記の380行目だと思います。

https://github.com/firebase/firebase-admin-node/blob/master/src/index.d.ts

Comments

[aiueo12]

性格悪い奴やなあ

Answer 2

admin はFirebaseの各機能のAdmin権限を持つ名前空間の集まりです。
機能ごとにインスタンスを作成して使い始めます。

例えば Firestore であれば

const firestore = admin.firestore();
firestore.doc('document-path').set(...);

ですし、Authentication であれば

const auth = admin.auth();
const user = auth.getUser('uid');

で利用できます。

各機能インスタンスを生成する一覧は以下。（firebase-namespace-api.d.tsより）

auth(): auth.Auth;
database(url?: string): database.Database;
firestore(): firestore.Firestore;
instanceId(): instanceId.InstanceId;
machineLearning(): machineLearning.MachineLearning;
messaging(): messaging.Messaging;
projectManagement(): projectManagement.ProjectManagement;
remoteConfig(): remoteConfig.RemoteConfig;
securityRules(): securityRules.SecurityRules;
storage(): storage.Storage;

機能インスタンスを生成すれば、インテリセンスでメソッドとプロパティの一覧が表示されるので何とかなるのではないかと。