Firebaseを使っていて、もしくはfirebaseを使ったアプリなどの作成の解説動画や記事をみていると、いきなり、
「createUserWithEmailAndPasswordはuserを返すので、」
とか、
「getはsnapshotを返すので」
のようなことを言われて、Firebase初心者だと、「なんで？？」ってなることが多かったので、この記事を作成しました。
結論：Firebase API Referenceに全部書いてあった🤣
まずは結論から言ってしまいますが、Firebase API Referenceに全て書いてあります。
これはFirebaseの公式ドキュメントの一部なのですが、残念ながら現時点(2020年11月)では日本語化はされておらず、英語のみとなっています。しかしながら、以下の画像ように説明は英語ですが、メソッドごとに取る引数やその型、返り値などが実際のコードのような形で書かれているので、英語が苦手な方でも理解しやすいと思います。
例えば、冒頭で例にあげた、createUserWithEmailAndPasswordがuserを返すのをどうやって知るのか、というと、
まずは、該当のメソッドのところまで行って、返り値を確認します。
今回はPromise <UserCredential>となっている！
つまり、ユーザーの作成が完了した段階でUserCredentialが返ってくることになります。
で、UserCredentialとはなんぞやというと、そのリンク先を見ればわかるわけです。
早速みてみましょう。
ここにuserがありました！！
まとめ
というわけで、もう一度この例を振り返ってまとめてみると、
- 返り値や引数がわからない🤔
- Firebase API Referenceを開いて、該当のメソッドを見つける
- 引数、返り値を確認
- 引数、返り値のより詳細な情報を知りたい場合はそれらをクリック
- Happyになる🙆♀️🙆♂️
ちなみに、最近は翻訳技術がすごくなってきているので、翻訳機能使って訳しつつ読むのも良いかもしれません。DeepLがおすすめです。