useGetCollection に近い Hooks ですが、大きな違いとして useLazyGetCollection は関数を実行して初めてデータの取得を行います。

const [collectionData, loading, error, loadFn] = useLazyGetCollection(path, options);

Hooks の戻り値

collectionData: CollectionData

Firestore から取得したコレクションの内容であり、
初期値には [] が代入されています。
loading: boolean

データを取得しているかを表します。
error: Error

データ取得の際にエラーが発生した場合エラー内容が入力されます。
初期値にはnullが代入されています。
loadFn: () => void

データを取得するための関数です。

Hooks の引数

path: string

取得対象のコレクションの Firestore 上のパスです。
optional options: object

データを取得する際のオプションです。

options の内容

optional callback: (DocData) => void

データを取得する際に実行される関数を指定することができます。
optional acceptOutdated: boolean

Fireclient ではリッスンしているコレクションを取得する際にキャッシュを利用しますが、その機能を過去に取得したコレクションの再取得にも適応します。
optional where: Where

条件を付けてコレクションを取得することができます。
optional limit: Limit

取得するコレクションの数を制限することができます。
optional order: Order

コレクションをソートした状態で取得します。limit と組み合わせることで、上位 n 個を取得ということができます。
optional cursor: Cursor

取得するコレクションの開始地点・終了地点を指定します。

注意：Firestore 上のパスは /Collection/Doc/Collection/Doc/... となっていることに注意してください。もしドキュメントを取得する場合は、代わりに useLazyGetDoc を使用してください。

Example

const [citiesData, loading, error, loadFn] = useLazyGetCollection("/cities");

次を実行することで初めてデータが取得されます。

loadFn();

citiesData には次のような内容が代入されます。

[
  {
    data: {
      country: "Mexico",
      name: "Mexico City",
      population: 19028000,
    },
    id: "MexicoCity",
  },
  {
    data: {
      country: "India",
      name: "Mumbai",
      population: 18978000,
    },
    id: "Mumbai",
  },
  {
    data: {
      country: "United States",
      name: "New York",
      population: 19354922,
      users: ["Baker", "Davis"],
    },
    id: "NewYork",
  },
  {
    data: {
      country: "Brazil",
      name: "São Paulo",
      population: 18845000,
    },
    id: "SaoPaulo",
  },
  {
    data: {
      country: "Japan",
      name: "Tokyo",
      population: 35676000,
    },
    id: "Tokyo",
  },
];