@firebase/firestore

関数

クラス

インターフェース

変数

型エイリアス

関数（アプリ、...）

getFirestore（アプリ）

指定された FirebaseApp に関連付けられている既存のデフォルトの Firestore インスタンスを返します。インスタンスが存在しない場合は、新しいインスタンスをデフォルト設定で初期化します。

署名:

export declare function getFirestore(app: FirebaseApp): Firestore;

パラメータ

戻り値:

Firestore

指定されたアプリのデフォルトの Firestore インスタンス。

getFirestore(app, databaseId)

この API はデベロッパー向けのプレビュー版として提供されており、寄せられたフィードバックに基づいて変更される可能性があります。この API は本番環境で使用しないでください。

指定された FirebaseApp に関連付けられている既存の名前付き Firestore インスタンスを返します。インスタンスが存在しない場合は、新しいインスタンスをデフォルト設定で初期化します。

署名:

export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;

パラメータ

戻り値:

Firestore

指定されたアプリの名前付きの Firestore インスタンス。

InitializeFirestore(app, settings, databaseId)

指定された設定で Firestore の新しいインスタンスを初期化します。他の関数（getFirestore() など）の前にのみ呼び出すことができます。カスタム設定が空の場合、この関数は getFirestore() の呼び出しと同じです。

署名:

export declare function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings, databaseId?: string): Firestore;

パラメータ

戻り値:

Firestore

新たに初期化された Firestore インスタンス。

関数（firestore, ...）

ClearIndexedDbPersistence(firestore)

永続ストレージを消去します。これには、保留中の書き込みやキャッシュに保存されたドキュメントが含まれます。

Firestore インスタンスが起動していない間（アプリの終了後、またはアプリの初回初期化時）に呼び出す必要があります。起動時に、この関数を他の関数（InitializeFirestore() または getFirestore() 以外）の前に呼び出す必要があります。Firestore インスタンスがまだ実行中の場合、Promise は拒否され、エラーコード failed-precondition が返されます。

署名:

export declare function clearIndexedDbPersistence(firestore: Firestore): Promise<void>;

パラメータ

戻り値:

約束 <void>

永続ストレージが消去されたときに解決される Promise。それ以外の場合、Promise はエラーで拒否されます。

コレクション（firestore、path、pathSegments）

指定された絶対パスにあるコレクションを参照する CollectionReference インスタンスを取得します。

署名:

export declare function collection(firestore: Firestore, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

パラメータ

戻り値:

CollectionReference<DocumentData、DocumentData>

CollectionReference インスタンス。

例外

最終的なパスのセグメント数が偶数で、コレクションを参照していない場合。

collectionGroup(firestore, collectionId)

指定された collectionId を持つコレクションまたはサブコレクションに含まれるデータベース内のすべてのドキュメントを含む、新しい Query インスタンスを作成して返します。

署名:

export declare function collectionGroup(firestore: Firestore, collectionId: string): Query<DocumentData, DocumentData>;

パラメータ

戻り値:

Query<DocumentData, DocumentData>

作成された Query。

connectFirestoreEmulator（ファイアストア、ホスト、ポート、オプション）

このインスタンスを変更して、Cloud Firestore エミュレータと通信します。

署名:

export declare function connectFirestoreEmulator(firestore: Firestore, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

パラメータ

戻り値:

void

disableNetwork（firestore）

このインスタンスのネットワーク使用を無効にします。enableNetwork() を介して再度有効にできます。ネットワークが無効になっている場合、スナップショット リスナー、getDoc() または getDocs() の呼び出しはキャッシュから結果を返します。書き込みオペレーションは、ネットワークが復元されるまでキューに追加されます。

署名:

export declare function disableNetwork(firestore: Firestore): Promise<void>;

パラメータ

戻り値:

約束 <void>

ネットワークが無効になった後に解決される Promise。

doc（firestore、path、pathSegments）

指定された絶対パスのドキュメントを参照する DocumentReference インスタンスを取得します。

署名:

export declare function doc(firestore: Firestore, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

パラメータ

戻り値:

DocumentReference<DocumentData、DocumentData>

DocumentReference インスタンス。

例外

最終的なパスのセグメント数が奇数で、ドキュメントを参照していない場合。

enableIndexedDbPersistence(firestore, persistenceSettings)

</ph>

この関数は今後のメジャー リリースで削除される予定です。代わりに、FirestoreSettings.localCache を PersistentLocalCache のインスタンスに設定して、IndexedDb キャッシュを有効にします。FirestoreSettings.localCache がすでに指定されているときにこの関数を呼び出すと、例外がスローされます。

可能であれば永続ストレージの有効化を試みます。

失敗すると、enableIndexedDbPersistence() は Promise を拒否するか、例外をスローします。これが失敗する理由はいくつかあり、エラーの code で特定できます。

* failed-precondition: アプリはすでに別のブラウザタブで開かれています。* unImplemented: ブラウザはオフラインの永続性実装と互換性がありません。

障害が発生しても Firestore インスタンスは引き続き使用できますが、オフラインの永続性は無効になります。

Node.js 環境では永続性は使用できません。

署名:

export declare function enableIndexedDbPersistence(firestore: Firestore, persistenceSettings?: PersistenceSettings): Promise<void>;

パラメータ

戻り値:

約束 <void>

永続ストレージの有効化が正常に行われたことを表す Promise。

enableMultiTabIndexedDbPersistence(firestore)

</ph>

この関数は今後のメジャー リリースで削除される予定です。代わりに、FirestoreSettings.localCache を PersistentLocalCache のインスタンスに設定して、indexeddb キャッシュを有効にします。FirestoreSettings.localCache がすでに指定されているときにこの関数を呼び出すと、例外がスローされます。

可能であれば、マルチタブの永続ストレージの有効化を試みます。すべてのタブで有効にすると、すべての操作で永続ローカル ストレージへのアクセスが共有されます。これには、接続されているすべてのインスタンス間でのクエリの実行やレイテンシ補正によるローカル ドキュメントの更新が含まれます。

失敗すると、enableMultiTabIndexedDbPersistence() は Promise を拒否するか、例外をスローします。これが失敗する理由はいくつかあり、エラーの code で特定できます。

* failed-precondition: アプリはすでに別のブラウザタブで開いており、マルチタブが有効になっていません。* unImplemented: ブラウザはオフラインの永続性実装と互換性がありません。

障害が発生しても Firestore インスタンスは引き続き使用できますが、オフラインの永続性は無効になります。

署名:

export declare function enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise<void>;

パラメータ

戻り値:

約束 <void>

永続ストレージの有効化が正常に行われたことを表す Promise。

enableNetwork（firestore）

前回の disableNetwork() の呼び出しの後に、この Firestore インスタンスのネットワークの使用を再度有効にします。

署名:

export declare function enableNetwork(firestore: Firestore): Promise<void>;

パラメータ

戻り値:

約束 <void>

ネットワークが有効になると解決される Promise。

getPersistentCacheIndexManager(firestore)

指定された Firestore オブジェクトで使用される PersistentCache インデックス マネージャーを返します。

PersistentCacheIndexManager インスタンス。ローカル永続ストレージが使用されていない場合は null。

署名:

export declare function getPersistentCacheIndexManager(firestore: Firestore): PersistentCacheIndexManager | null;

パラメータ

戻り値:

PersistentCacheIndexManager |null

loadBundle(firestore, bundleData)

Firestore バンドルをローカル キャッシュに読み込みます。

署名:

export declare function loadBundle(firestore: Firestore, bundleData: ReadableStream<Uint8Array> | ArrayBuffer | string): LoadBundleTask;

パラメータ

戻り値:

LoadBundleTask

LoadBundleTask オブジェクト。呼び出し元に進行状況の更新、完了イベント、エラーイベントを通知します。Promise<LoadBundleTaskProgress> として使用できます。

nameQuery(firestore, name)

指定の名前で識別されるローカル キャッシュから Firestore クエリを読み取ります。

名前付きクエリは、結果のドキュメントとともにサーバー側でバンドルにパッケージ化され、loadBundle を使用してローカル キャッシュに読み込まれます。ローカル キャッシュに格納されたら、このメソッドを使用して名前で Query を抽出します。

署名:

export declare function namedQuery(firestore: Firestore, name: string): Promise<Query | null>;

パラメータ

戻り値:

Promise<クエリ |null>

クエリまたは null で解決される Promise。

onSnapshotsInSync(firestore, observer)

スナップショットの同期イベントのリスナーをアタッチします。snapshot-in-sync イベントは、サーバーが生成した 1 つの変更が複数のリスナーに影響を及ぼす場合でも、特定の変更の影響を受けるすべてのリスナーが起動したことを示します。

注: snapshot-in-sync イベントは、リスナーが互いに同期していることを示すだけで、それらのスナップショットがサーバーと同期しているかどうかには関係しません。個々のリスナーで SnapshotMetadata を使用して、スナップショットがキャッシュとサーバーのどちらから取得されたものかを判別します。

署名:

export declare function onSnapshotsInSync(firestore: Firestore, observer: {
    next?: (value: void) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

パラメータ

戻り値:

配信停止

スナップショット リスナーをキャンセルするために呼び出すことができる登録解除関数。

onSnapshotsInSync（firestore, onSync）

スナップショットの同期イベントのリスナーをアタッチします。snapshot-in-sync イベントは、サーバーが生成した 1 つの変更が複数のリスナーに影響を及ぼす場合でも、特定の変更の影響を受けるすべてのリスナーが起動したことを示します。

注: snapshot-in-sync イベントは、リスナーが互いに同期していることを示すだけで、それらのスナップショットがサーバーと同期しているかどうかには関係しません。個々のリスナーで SnapshotMetadata を使用して、スナップショットがキャッシュとサーバーのどちらから取得されたかを判別します。

署名:

export declare function onSnapshotsInSync(firestore: Firestore, onSync: () => void): Unsubscribe;

パラメータ

戻り値:

配信停止

スナップショット リスナーをキャンセルするために呼び出すことができる登録解除関数。

runTransaction(firestore, updateFunction, options)

指定された updateFunction を実行し、トランザクション内で適用された変更を commit しようとします。トランザクション内で読み取られたドキュメントが変更されると、Cloud Firestore は updateFunction を再試行します。5 回試行しても commit に失敗すると、トランザクションは失敗します。

1 回のトランザクションで許可される最大書き込み回数は 500 回です。

署名:

export declare function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>, options?: TransactionOptions): Promise<T>;

パラメータ

戻り値:

Promise<T>

トランザクションが正常に完了したか、明示的に中止された（updateFunction が失敗した Promise を返した）場合は、updateFunction によって返された Promise がここに返されます。トランザクションが失敗した場合は、拒否された Promise と対応する失敗エラーが返されます。

setIndexConfiguration(firestore, configuration)

この API はデベロッパー向けのプレビュー版として提供されており、寄せられたフィードバックに基づいて変更される可能性があります。この API は本番環境で使用しないでください。

</ph>

キャッシュ インデックスを手動で作成する代わりに、enablePersistentCacheIndexAutoCreation() を使用して、ローカルで実行されるクエリのキャッシュ インデックスを作成するかどうかを SDK に判断させることを検討してください。

ローカルクエリを実行するためのインデックスを構成します。以前のインデックス構成はすべてオーバーライドされます。インデックス構成が保持されると、Promise が解決されます。

インデックス エントリ自体は非同期で作成されます。インデックスがまだ利用できない場合でも、インデックスを必要とするクエリを引き続き使用できます。インデックス エントリが書き込まれると、そのインデックスを使用してクエリの実行が自動的に開始されます。

インデックスは IndexedDb の永続性でのみサポートされます。IndexedDb が有効になっていない場合、インデックス構成は無視されます。

署名:

export declare function setIndexConfiguration(firestore: Firestore, configuration: IndexConfiguration): Promise<void>;

パラメータ

戻り値:

約束 <void>

すべてのインデックスが正常に構成されると解決される Promise。

例外

JSON 形式が無効な場合は FirestoreError。

setIndexConfiguration(firestore, json)

この API はデベロッパー向けのプレビュー版として提供されており、寄せられたフィードバックに基づいて変更される可能性があります。この API は本番環境で使用しないでください。

</ph>

キャッシュ インデックスを手動で作成する代わりに、enablePersistentCacheIndexAutoCreation() を使用して、ローカルで実行されるクエリのキャッシュ インデックスを作成するかどうかを SDK に判断させることを検討してください。

ローカルクエリを実行するためのインデックスを構成します。以前のインデックス構成はすべてオーバーライドされます。インデックス構成が保持されると、Promise が解決されます。

インデックス エントリ自体は非同期で作成されます。インデックスがまだ利用できない場合でも、インデックスを必要とするクエリを引き続き使用できます。インデックス エントリが書き込まれると、そのインデックスを使用してクエリの実行が自動的に開始されます。

インデックスは IndexedDb の永続性でのみサポートされます。インデックス構成を設定する前に、enableIndexedDbPersistence() または enableMultiTabIndexedDbPersistence() を呼び出します。IndexedDb が有効になっていない場合、インデックス構成は無視されます。

このメソッドは、Firebase CLI（firebase firestore:indexes）によってエクスポートされた JSON 形式を受け入れます。JSON 形式が無効な場合、このメソッドはエラーをスローします。

署名:

export declare function setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;

パラメータ

戻り値:

約束 <void>

すべてのインデックスが正常に構成されると解決される Promise。

例外

JSON 形式が無効な場合は FirestoreError。

終了（firestore）

指定された Firestore インスタンスを終了します。

terminate() を呼び出した後は、clearIndexedDbPersistence() 関数のみを使用できます。その他の関数は FirestoreError をスローします。

終了後に再起動するには、getFirestore() を使用して FirebaseFirestore の新しいインスタンスを作成します。

終了によって保留中の書き込みはキャンセルされず、サーバーからの応答を待っている Promise は解決されません。永続性を有効にしている場合、このインスタンスを次回起動すると、これらの書き込みのサーバーへの送信が再開されます。

署名:

export declare function terminate(firestore: Firestore): Promise<void>;

パラメータ

戻り値:

約束 <void>

インスタンスが正常に終了したときに解決される Promise。

waitForPendingWrites（ファイアストア）

アクティブ ユーザーへの現在保留中の書き込みがすべてバックエンドによって承認されるまで待機します。

未処理の書き込みがない場合、返される Promise は直ちに解決されます。それ以外の場合、Promise は以前に発行されたすべての書き込み（前のアプリ セッションで書き込まれた書き込みを含む）を待機しますが、関数が呼び出された後に追加された書き込みは待機しません。追加の書き込みを待つ場合は、もう一度 waitForPendingWrites() を呼び出します。

未処理の waitForPendingWrites() Promise は、ユーザー変更中に拒否されます。

署名:

export declare function waitForPendingWrites(firestore: Firestore): Promise<void>;

パラメータ

戻り値:

約束 <void>

Promise。現在保留中のすべての書き込みがバックエンドによって確認されると解決されます。

writeBatch（firestore）

複数の書き込みを単一のアトミック オペレーションとして実行するために使用する書き込みバッチを作成します。1 つの WriteBatch で許可される書き込みの最大数は 500 です。

トランザクションとは異なり、書き込みバッチはオフラインで保持されるため、読み取りデータに対する書き込みの条件が不要な場合に適しています。

署名:

export declare function writeBatch(firestore: Firestore): WriteBatch;

パラメータ

戻り値:

WriteBatch

複数の書き込みをアトミックに実行するために使用できる WriteBatch。

関数

count()

クエリの結果セットに含まれるドキュメント数の計算に使用できる AggregateField オブジェクトを作成します。

署名:

export declare function count(): AggregateField<number>;

戻り値:

AggregateField<number>

deleteField()

updateDoc() または setDoc() で {merge: true} を指定してフィールドを削除するマークを付け、使用するセンチネルを返します。

署名:

export declare function deleteField(): FieldValue;

戻り値:

フィールド値

documentId()

ドキュメントの ID を参照する特別な標識 FieldPath を返します。クエリでドキュメント ID による並べ替えやフィルタリングに使用できます。

署名:

export declare function documentId(): FieldPath;

戻り値:

FieldPath

getFirestore()

デフォルトの FirebaseApp に関連付けられている既存のデフォルトの Firestore インスタンスを返します。インスタンスが存在しない場合は、新しいインスタンスをデフォルト設定で初期化します。

署名:

export declare function getFirestore(): Firestore;

戻り値:

Firestore

デフォルト アプリのデフォルトの Firestore インスタンス。

memoryEagerGarbageCollector()

MemoryEagerGarbageCollector のインスタンスを作成します。特に指定しない限り、これはデフォルトのガベージ コレクタでもあります。

署名:

export declare function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;

戻り値:

MemoryEagerGarbageCollector

PersistentMultipleTabManager()

PersistentMultipleTabManager のインスタンスを作成します。

署名:

export declare function persistentMultipleTabManager(): PersistentMultipleTabManager;

戻り値:

PersistentMultipleTabManager

serverTimestamp()

サーバーで生成されたタイムスタンプを書き込まれるデータに含めるために setDoc() または updateDoc() で使用する標識を返します。

署名:

export declare function serverTimestamp(): FieldValue;

戻り値:

フィールド値

function（databaseId, ...）

getFirestore(databaseId)

この API はデベロッパー向けのプレビュー版として提供されており、寄せられたフィードバックに基づいて変更される可能性があります。この API は本番環境で使用しないでください。

デフォルトの FirebaseApp に関連付けられている既存の名前付き Firestore インスタンスを返します。インスタンスが存在しない場合は、新しいインスタンスをデフォルト設定で初期化します。

署名:

export declare function getFirestore(databaseId: string): Firestore;

パラメータ

戻り値:

Firestore

デフォルト アプリの名前付きの Firestore インスタンス。

関数（要素, ...）

配列削除(要素)

setDoc() で使用できるか、サーバーにすでに存在するすべての配列値から指定された要素を削除するようサーバーに指示する特別な値を返します。指定した各要素のすべてのインスタンスが配列から削除されます。変更されるフィールドがまだ配列でない場合、空の配列で上書きされます。

署名:

export declare function arrayRemove(...elements: unknown[]): FieldValue;

パラメータ

戻り値:

フィールド値

setDoc() または updateDoc() への呼び出しで使用する FieldValue 標識

arrayUnion(elements)

setDoc() または updateDoc() で指定できる特殊な値を返します。この値は、指定された要素をサーバーにすでに存在する任意の配列値と統合するようサーバーに指示します。指定した配列にまだ存在しない各要素は、末尾に追加されます。変更されるフィールドがまだ配列でない場合、指定された要素だけを含む配列で上書きされます。

署名:

export declare function arrayUnion(...elements: unknown[]): FieldValue;

パラメータ

戻り値:

フィールド値

setDoc() または updateDoc() への呼び出しで使用する FieldValue 標識。

function(field, ...)

average(field)

クエリの結果セットに含まれる一連のドキュメントに対して指定されたフィールドの平均値を計算するために使用できる AggregateField オブジェクトを作成します。

署名:

export declare function average(field: string | FieldPath): AggregateField<number | null>;

パラメータ

戻り値:

AggregateField<number |null>

sum(field)

クエリの結果セットのドキュメント範囲に対して指定したフィールドの合計を計算するために使用できる AggregateField オブジェクトを作成します。

署名:

export declare function sum(field: string | FieldPath): AggregateField<number>;

パラメータ

戻り値:

AggregateField<number>

function(fieldPath, ...)

orderBy(fieldPath, directionalStr)

指定されたフィールドでクエリ結果を昇順ではなく降順で並べ替える QueryOrderByConstraint を作成します。

署名:

export declare function orderBy(fieldPath: string | FieldPath, directionStr?: OrderByDirection): QueryOrderByConstraint;

パラメータ

戻り値:

QueryOrderByConstraint

作成された QueryOrderByConstraint 。

ここで(fieldPath, opStr, value)

指定されたフィールドがドキュメントに含まれる必要があり、その値が指定されたリレーション制約を満たすように強制する QueryFieldFilterConstraint を作成します。

署名:

export declare function where(fieldPath: string | FieldPath, opStr: WhereFilterOp, value: unknown): QueryFieldFilterConstraint;

パラメータ

戻り値:

QueryFieldFilterConstraint

作成された QueryFieldFilterConstraint 。

function(fieldValues, ...)

endAt(fieldValues)

クエリの順序を基準にして、指定されたフィールドで結果セットが終わるように結果セットを変更する QueryEndAtConstraint を作成します。フィールド値の順序は、クエリの order by 句の順序と一致している必要があります。

署名:

export declare function endAt(...fieldValues: unknown[]): QueryEndAtConstraint;

パラメータ

戻り値:

QueryEndAtConstraint

query() に渡す QueryEndAtConstraint

endBefore(fieldValues)

クエリの順序に応じて、結果セットが指定されたフィールドよりも前に終了するように変更する QueryEndAtConstraint を作成します。フィールド値の順序は、クエリの order by 句の順序と一致している必要があります。

署名:

export declare function endBefore(...fieldValues: unknown[]): QueryEndAtConstraint;

パラメータ

戻り値:

QueryEndAtConstraint

query() に渡す QueryEndAtConstraint

startAfter(fieldValues)

クエリの順序を基準にして、指定されたフィールドの後に結果セットが開始されるように結果セットを変更する QueryStartAtConstraint を作成します。フィールド値の順序は、クエリの order by 句の順序と一致している必要があります。

署名:

export declare function startAfter(...fieldValues: unknown[]): QueryStartAtConstraint;

パラメータ

戻り値:

QueryStartAtConstraint

query() に渡す QueryStartAtConstraint

startAt(fieldValues)

クエリの順序を基準にして、指定されたフィールドから結果セットが開始されるように結果セットを変更する QueryStartAtConstraint を作成します。フィールド値の順序は、クエリの order by 句の順序と一致している必要があります。

署名:

export declare function startAt(...fieldValues: unknown[]): QueryStartAtConstraint;

パラメータ

戻り値:

QueryStartAtConstraint

query() に渡す QueryStartAtConstraint。

function（indexManager, ...）

deleteAllPersistentCacheIndexes(indexManager)

すべての永続キャッシュ インデックスを削除します。

この関数は、サポートが終了した setIndexConfiguration() によって生成されたインデックスも削除されます。

署名:

export declare function deleteAllPersistentCacheIndexes(indexManager: PersistentCacheIndexManager): void;

パラメータ

戻り値:

void

disablePersistentCacheIndexAutoCreation(indexManager)

ローカルクエリの実行用の永続キャッシュ インデックスの作成を自動的に停止します。enablePersistentCacheIndexAutoCreation() を呼び出して作成したインデックスは引き続き有効です。

署名:

export declare function disablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;

パラメータ

戻り値:

void

enablePersistentCacheIndexAutoCreation(indexManager)

キャッシュ インデックスがパフォーマンスの向上に役立つと SDK が判断した場合、ローカルクエリの実行用の永続キャッシュ インデックスを SDK が自動的に作成できるようにします。

この機能はデフォルトで無効になっています。

署名:

export declare function enablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;

パラメータ

戻り値:

void

関数（左、...）

aggregateFieldEqual(left, right)

2 つの 'AggregateField` インスタンスを比較し、等価であるかどうかをチェックします。

署名:

export declare function aggregateFieldEqual(left: AggregateField<unknown>, right: AggregateField<unknown>): boolean;

パラメータ

戻り値:

ブール値

aggregateQuerySnapshotEqual(left, right)

2 つの AggregateQuerySnapshot インスタンスが等価であるかどうかを比較します。

2 つの AggregateQuerySnapshot インスタンスが「等しい」と見なされます基になるクエリが同じ比較対象であり、同じデータを持っている場合です。

署名:

export declare function aggregateQuerySnapshotEqual<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(left: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>, right: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>): boolean;

パラメータ

戻り値:

ブール値

上記で定義されているようにオブジェクトが「等しい」場合は true、それ以外の場合は false。

queryEqual（左, 右）

指定されたクエリが同じコレクションをポイントし、同じ制約を適用している場合、true を返します。

署名:

export declare function queryEqual<AppModelType, DbModelType extends DocumentData>(left: Query<AppModelType, DbModelType>, right: Query<AppModelType, DbModelType>): boolean;

パラメータ

戻り値:

ブール値

参照が同じ Firestore データベース内の同じ場所を指している場合は true。

refEqual（左, 右）

指定された参照が等しい場合は true を返します。

署名:

export declare function refEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>, right: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>): boolean;

パラメータ

戻り値:

ブール値

参照が同じ Firestore データベース内の同じ場所を指している場合は true。

snapshotEqual（左、右）

指定されたスナップショットが等しい場合は true を返します。

署名:

export declare function snapshotEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>, right: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>): boolean;

パラメータ

戻り値:

ブール値

スナップショットが等しい場合は true を返します。

function(limit, ...)

制限（limit）

最初に一致するドキュメントのみを返す QueryLimitConstraint を作成します。

署名:

export declare function limit(limit: number): QueryLimitConstraint;

パラメータ

戻り値:

QueryLimitConstraint

作成された QueryLimitConstraint です。

limitToLast(limit)

最後に一致したドキュメントのみを返す QueryLimitConstraint を作成します。

limitToLast クエリには少なくとも 1 つの orderBy 句を指定する必要があります。指定しない場合、実行時に例外がスローされます。

署名:

export declare function limitToLast(limit: number): QueryLimitConstraint;

パラメータ

戻り値:

QueryLimitConstraint

作成された QueryLimitConstraint です。

function(logLevel, ...)

setLogLevel(logLevel)

Cloud Firestore ログの詳細度を設定します（デバッグ、エラー、サイレント）。

署名:

export declare function setLogLevel(logLevel: LogLevel): void;

パラメータ

戻り値:

void

関数(n, ...)

インクリメント(n)

フィールドの現在の値を指定された値だけ増やすようサーバーに指示する setDoc() または updateDoc() で使用できる特別な値を返します。

オペランドまたは現在のフィールド値のいずれかで浮動小数点精度を使用する場合、すべての演算は IEEE 754 セマンティクスに従います。両方の値が整数の場合、JavaScript の安全な数値範囲（Number.MIN_SAFE_INTEGER～Number.MAX_SAFE_INTEGER）外の値も精度が失われる可能性があります。さらに、Firestore バックエンドで処理されると、すべての整数演算は -2^63 から 2^63-1 の間で制限されます。

現在のフィールド値の型が number でない場合、またはフィールドがまだ存在しない場合、変換により、指定された値にフィールドが設定されます。

署名:

export declare function increment(n: number): FieldValue;

パラメータ

戻り値:

フィールド値

setDoc() または updateDoc() への呼び出しで使用する FieldValue 標識

function(query, ...)

getAggregateFromServer(query, aggregateSpec)

実際にドキュメントをダウンロードせずに、指定されたクエリの結果セットに含まれるドキュメントに対して、指定された集計を計算します。

この関数を使用して集計を行うと効率的です。ドキュメントの集計値ではなく最終的な集計値のみが集計されるため、ダウンロードされます。結果セットが大きすぎて完全にダウンロードできない（数千のドキュメント）場合に、この関数はドキュメントの集計を実行できます。

サーバーから受信した結果は、ローカルの状態を考慮せず、変更されることなく表示されます。つまり、ローカル キャッシュ内のドキュメントも、ローカルの変更がサーバーと同期されていないことも考慮されません。以前にダウンロードした結果（ある場合）は使用されません。この関数が呼び出されるたびに、サーバーへのラウンドトリップが必要になります。

署名:

export declare function getAggregateFromServer<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, aggregateSpec: AggregateSpecType): Promise<AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>>;

パラメータ

戻り値:

Promise<AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>>

例

const aggregateSnapshot = await getAggregateFromServer(query, {
  countOfDocs: count(),
  totalHours: sum('hours'),
  averageScore: average('score')
});

const countOfDocs: number = aggregateSnapshot.data().countOfDocs;
const totalHours: number = aggregateSnapshot.data().totalHours;
const averageScore: number | null = aggregateSnapshot.data().averageScore;

getCountFromServer(query)

実際にドキュメントをダウンロードせずに、指定されたクエリの結果セットに含まれるドキュメントの数を計算します。

この関数を使用してドキュメントのカウントを行うと効率的です。これは、ドキュメントのカウントではなく、最終的なカウントのみが行われるためです。ダウンロードされます。この関数は、結果セットのサイズが大きすぎて完全にダウンロードできない（数千のドキュメント）場合に、ドキュメントをカウントできます。

サーバーから受信した結果は、ローカルの状態を考慮せず、変更されることなく表示されます。つまり、ローカル キャッシュ内のドキュメントも、ローカルの変更がサーバーと同期されていないことも考慮されません。以前にダウンロードした結果（ある場合）は使用されません。この関数が呼び出されるたびに、サーバーへのラウンドトリップが必要になります。

署名:

export declare function getCountFromServer<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<AggregateQuerySnapshot<{
    count: AggregateField<number>;
}, AppModelType, DbModelType>>;

パラメータ

戻り値:

Promise<AggregateQuerySnapshot<{ count: AggregateField<number>;}、AppModelType、DbModelType>>

カウントで解決される Promiseカウントは snapshot.data().count から取得できます。ここで、snapshot は、返された Promise が解決する AggregateQuerySnapshot です。

getDocs(query)

クエリを実行し、結果を QuerySnapshot として返します。

署名:

export declare function getDocs<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

パラメータ

戻り値:

Promise<QuerySnapshot<AppModelType, DbModelType>>

クエリの結果で解決される Promise。

getDocsFromCache(query)

クエリを実行し、結果をキャッシュから QuerySnapshot として返します。クエリに一致するドキュメントが現在キャッシュに保存されていない場合は、空の結果セットを返します。

署名:

export declare function getDocsFromCache<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

パラメータ

戻り値:

Promise<QuerySnapshot<AppModelType, DbModelType>>

クエリの結果で解決される Promise。

getDocsFromServer(query)

クエリを実行し、サーバーから QuerySnapshot として結果を返します。ネットワークが利用できない場合はエラーを返します。

署名:

export declare function getDocsFromServer<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

パラメータ

戻り値:

Promise<QuerySnapshot<AppModelType, DbModelType>>

クエリの結果で解決される Promise。

onSnapshot(クエリ, オブザーバー)

QuerySnapshot イベントのリスナーをアタッチします。onNext コールバックと onError コールバックを個別に渡すか、next コールバックと error コールバックで単一のオブザーバー オブジェクトを渡せます。onSnapshot が呼び出されたときに返される関数を呼び出すと、リスナーをキャンセルできます。

注: onCompletion コールバックは提供できますが、スナップショット ストリームに終わりがないため、呼び出されることはありません。

署名:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, observer: {
    next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

パラメータ

戻り値:

配信停止

スナップショット リスナーをキャンセルするために呼び出すことができる登録解除関数。

onSnapshot(クエリ, オプション, オブザーバー)

QuerySnapshot イベントのリスナーをアタッチします。onNext コールバックと onError コールバックを個別に渡すか、next コールバックと error コールバックで単一のオブザーバー オブジェクトを渡せます。onSnapshot が呼び出されたときに返される関数を呼び出すと、リスナーをキャンセルできます。

注: onCompletion コールバックは提供できますが、スナップショット ストリームに終わりがないため、呼び出されることはありません。

署名:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, options: SnapshotListenOptions, observer: {
    next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

パラメータ

戻り値:

配信停止

スナップショット リスナーをキャンセルするために呼び出すことができる登録解除関数。

onSnapshot(query, onNext, onError, oncompletion)

QuerySnapshot イベントのリスナーをアタッチします。onNext コールバックと onError コールバックを個別に渡すか、next コールバックと error コールバックで単一のオブザーバー オブジェクトを渡せます。onSnapshot が呼び出されたときに返される関数を呼び出すと、リスナーをキャンセルできます。

注: onCompletion コールバックは提供できますが、スナップショット ストリームに終わりがないため、呼び出されることはありません。

署名:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

パラメータ

戻り値:

配信停止

スナップショット リスナーをキャンセルするために呼び出すことができる登録解除関数。

onSnapshot(query, options, onNext, onError, oncompletion)

QuerySnapshot イベントのリスナーをアタッチします。onNext コールバックと onError コールバックを個別に渡すか、next コールバックと error コールバックで単一のオブザーバー オブジェクトを渡せます。onSnapshot が呼び出されたときに返される関数を呼び出すと、リスナーをキャンセルできます。

注: onCompletion コールバックは提供できますが、スナップショット ストリームに終わりがないため、呼び出されることはありません。

署名:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, options: SnapshotListenOptions, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

パラメータ

戻り値:

配信停止

スナップショット リスナーをキャンセルするために呼び出すことができる登録解除関数。

query（query、compositeFilter、queryConstraints）

追加のクエリ制約も含むように拡張された Query の新しい不変インスタンスを作成します。

署名:

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, compositeFilter: QueryCompositeFilterConstraint, ...queryConstraints: QueryNonFilterConstraint[]): Query<AppModelType, DbModelType>;

パラメータ

戻り値:

Query<AppModelType、DbModelType>

例外

指定されたクエリ制約のいずれかを、既存の制約または新しい制約と組み合わせることができない場合。

query（query, queryConstraints）

追加のクエリ制約も含むように拡張された Query の新しい不変インスタンスを作成します。

署名:

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, ...queryConstraints: QueryConstraint[]): Query<AppModelType, DbModelType>;

パラメータ

戻り値:

Query<AppModelType、DbModelType>

例外

指定されたクエリ制約のいずれかを、既存の制約または新しい制約と組み合わせることができない場合。

関数（queryConstraints, ...）

and(queryConstraints)

指定されたフィルタ制約の結合である新しい QueryCompositeFilterConstraint を作成します。結合フィルタには、指定されたフィルタをすべて満たすドキュメントが含まれます。

署名:

export declare function and(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

パラメータ

戻り値:

QueryCompositeFilterConstraint

新しく作成された QueryCompositeFilterConstraint 。

or(queryConstraints)

指定されたフィルタ制約の分離である新しい QueryCompositeFilterConstraint を作成します。分離フィルタには、指定されたフィルタのいずれかを満たすドキュメントが含まれます。

署名:

export declare function or(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

パラメータ

戻り値:

QueryCompositeFilterConstraint

新しく作成された QueryCompositeFilterConstraint 。

function(reference, ...)

addDoc(reference, data)

指定されたデータを含む新しいドキュメントを、指定された CollectionReference に追加し、ドキュメント ID を自動的に割り当てます。

署名:

export declare function addDoc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<DocumentReference<AppModelType, DbModelType>>;

パラメータ

戻り値:

Promise<DocumentReference<AppModelType, DbModelType>>

Promise は、バックエンドに書き込まれた後に新しく作成されたドキュメントを指す DocumentReference で解決されました（オフライン中は解決されません）。

コレクション（参照、パス、パスセグメント）

指定された相対パスで reference のサブコレクションを参照する CollectionReference インスタンスを取得します。

署名:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

パラメータ

戻り値:

CollectionReference<DocumentData、DocumentData>

CollectionReference インスタンス。

例外

最終的なパスのセグメント数が偶数で、コレクションを参照していない場合。

コレクション（参照、パス、パスセグメント）

指定された相対パスで reference のサブコレクションを参照する CollectionReference インスタンスを取得します。

署名:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

パラメータ

戻り値:

CollectionReference<DocumentData、DocumentData>

CollectionReference インスタンス。

例外

最終的なパスのセグメント数が偶数で、コレクションを参照していない場合。

deleteDoc(参照)

指定された DocumentReference によって参照されるドキュメントを削除します。

署名:

export declare function deleteDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<void>;

パラメータ

戻り値:

約束 <void>

ドキュメントがバックエンドから正常に削除されると解決される Promise（オフライン中は解決されません）。

doc（参照、パス、パスセグメント）

指定された相対パスで reference 内のドキュメントを参照する DocumentReference インスタンスを取得します。パスが指定されていない場合、自動的に生成された一意の ID が、返される DocumentReference に使用されます。

署名:

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path?: string, ...pathSegments: string[]): DocumentReference<AppModelType, DbModelType>;

パラメータ

戻り値:

DocumentReference<AppModelType、DbModelType>

DocumentReference インスタンス。

例外

最終的なパスのセグメント数が奇数で、ドキュメントを参照していない場合。

doc（参照、パス、パスセグメント）

指定された相対パスで reference 内のドキュメントを参照する DocumentReference インスタンスを取得します。

署名:

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

パラメータ

戻り値:

DocumentReference<DocumentData、DocumentData>

DocumentReference インスタンス。

例外

最終的なパスのセグメント数が奇数で、ドキュメントを参照していない場合。

getDoc(参照)

この DocumentReference が参照するドキュメントを読み取ります。

署名:

export declare function getDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

パラメータ

戻り値:

Promise<DocumentSnapshot<AppModelType, DbModelType>>

現在のドキュメントの内容を含む DocumentSnapshot で解決された Promise。

getDocFromCache(参照)

この DocumentReference が参照するドキュメントをキャッシュから読み取ります。ドキュメントが現在キャッシュされていない場合、エラーを返します。

署名:

export declare function getDocFromCache<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

パラメータ

戻り値:

Promise<DocumentSnapshot<AppModelType, DbModelType>>

現在のドキュメントの内容を含む DocumentSnapshot で解決された Promise。

getDocFromServer(参照)

この DocumentReference が参照するドキュメントをサーバーから読み取ります。ネットワークが利用できない場合はエラーを返します。

署名:

export declare function getDocFromServer<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

パラメータ

戻り値:

Promise<DocumentSnapshot<AppModelType, DbModelType>>

現在のドキュメントの内容を含む DocumentSnapshot で解決された Promise。

onSnapshot(参照, オブザーバー)

DocumentSnapshot イベントのリスナーをアタッチします。onNext コールバックと onError コールバックを個別に渡すか、next コールバックと error コールバックで単一のオブザーバー オブジェクトを渡せます。

注: onCompletion コールバックは提供できますが、スナップショット ストリームに終わりがないため、呼び出されることはありません。

署名:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, observer: {
    next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

パラメータ

戻り値:

配信停止

スナップショット リスナーをキャンセルするために呼び出すことができる登録解除関数。

onSnapshot(参照, オプション, オブザーバー)

DocumentSnapshot イベントのリスナーをアタッチします。onNext コールバックと onError コールバックを個別に渡すか、next コールバックと error コールバックで単一のオブザーバー オブジェクトを渡せます。

注: onCompletion コールバックは提供できますが、スナップショット ストリームに終わりがないため、呼び出されることはありません。

署名:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, options: SnapshotListenOptions, observer: {
    next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

パラメータ

戻り値:

配信停止

スナップショット リスナーをキャンセルするために呼び出すことができる登録解除関数。

onSnapshot(参照, onNext, onError, oncompletion)

DocumentSnapshot イベントのリスナーをアタッチします。onNext コールバックと onError コールバックを個別に渡すか、next コールバックと error コールバックで単一のオブザーバー オブジェクトを渡せます。

注: onCompletion コールバックは提供できますが、スナップショット ストリームに終わりがないため、呼び出されることはありません。

署名:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

パラメータ

戻り値:

配信停止

スナップショット リスナーをキャンセルするために呼び出すことができる登録解除関数。

onSnapshot(参照, オプション, onNext, onError, oncompletion)

DocumentSnapshot イベントのリスナーをアタッチします。onNext コールバックと onError コールバックを個別に渡すか、next コールバックと error コールバックで単一のオブザーバー オブジェクトを渡せます。

注: onCompletion コールバックは提供できますが、スナップショット ストリームに終わりがないため、呼び出されることはありません。

署名:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, options: SnapshotListenOptions, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

パラメータ

戻り値:

配信停止

スナップショット リスナーをキャンセルするために呼び出すことができる登録解除関数。

setDoc(reference, data)

この DocumentReference によって参照されるドキュメントに書き込みます。ドキュメントがまだ存在しない場合は作成されます。

署名:

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<void>;

パラメータ

戻り値:

約束 <void>

データがバックエンドに正常に書き込まれると、Promise が解決されます（オフライン中は解決されません）。

setDoc(参照, データ, オプション)

指定された DocumentReference によって参照されるドキュメントに書き込みます。ドキュメントがまだ存在しない場合は作成されます。merge または mergeFields を指定すると、指定されたデータを既存のドキュメントに統合できます。

署名:

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): Promise<void>;

パラメータ

戻り値:

約束 <void>

データがバックエンドに正常に書き込まれると解決される Promise（オフライン中は解決されません）。

updateDoc(reference, data)

指定された DocumentReference によって参照されるドキュメント内のフィールドを更新します。存在しないドキュメントに適用すると、更新は失敗します。

署名:

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): Promise<void>;

パラメータ

戻り値:

約束 <void>

データがバックエンドに正常に書き込まれると、Promise が解決されます（オフライン中は解決されません）。

updateDoc(参照, フィールド, 値, moreFieldsAndValues)

指定された DocumentReference によって参照されるドキュメント内のフィールドを更新します。存在しないドキュメントに更新を適用すると、更新は失敗します。

ネストされたフィールドを更新するには、ドット区切りのフィールドパス文字列を指定するか、FieldPath オブジェクトを指定します。

署名:

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;

パラメータ

戻り値:

約束 <void>

データがバックエンドに正常に書き込まれると、Promise が解決されます（オフライン中は解決されません）。

function(settings, ...)

memoryLocalCache(settings)

MemoryLocalCache のインスタンスを作成します。インスタンスを FirestoreSettings.cache に設定すると、使用するキャッシュ レイヤを SDK に指示できます。

署名:

export declare function memoryLocalCache(settings?: MemoryCacheSettings): MemoryLocalCache;

パラメータ

戻り値:

MemoryLocalCache

memoryLruGarbageCollector（設定）

MemoryLruGarbageCollector のインスタンスを作成します。

ターゲット サイズは、設定パラメータの一部として指定できます。キャッシュ サイズが指定されたサイズを超えると、コレクタによってドキュメントの削除が開始されます。デフォルトのキャッシュ サイズは 40 MB（40 * 1,024 * 1,024 バイト）です。

署名:

export declare function memoryLruGarbageCollector(settings?: {
    cacheSizeBytes?: number;
}): MemoryLruGarbageCollector;

パラメータ

戻り値:

MemoryLruGarbageCollector

PersistentLocalCache(settings)

PersistentLocalCache のインスタンスを作成します。インスタンスを FirestoreSettings.cache に設定すると、使用するキャッシュ レイヤを SDK に指示できます。

Node.js 環境では、永続キャッシュを使用できません。

署名:

export declare function persistentLocalCache(settings?: PersistentCacheSettings): PersistentLocalCache;

パラメータ

戻り値:

PersistentLocalCache

PersistentSingleTabManager(settings)

PersistentSingleTabManager のインスタンスを作成します。

署名:

export declare function persistentSingleTabManager(settings: PersistentSingleTabManagerSettings | undefined): PersistentSingleTabManager;

パラメータ

戻り値:

PersistentSingleTabManager

関数（スナップショット、...）

endAt（スナップショット）

指定されたドキュメント（両端を含む）で終了するように結果セットを変更する QueryEndAtConstraint を作成します。終了位置は、クエリの順序に相対的です。ドキュメントには、クエリの orderBy で指定されたすべてのフィールドが含まれている必要があります。

署名:

export declare function endAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

パラメータ

戻り値:

QueryEndAtConstraint

query() に渡す QueryEndAtConstraint

endBefore（スナップショット）

指定したドキュメント（排他的）の前に終了するように結果セットを変更する QueryEndAtConstraint を作成します。終了位置は、クエリの順序に相対的です。ドキュメントには、クエリの orderBy で指定されたすべてのフィールドが含まれている必要があります。

署名:

export declare function endBefore<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

パラメータ

戻り値:

QueryEndAtConstraint

query() に渡す QueryEndAtConstraint

startAfter（スナップショット）

指定したドキュメント（含まない）の後に開始するように結果セットを変更する QueryStartAtConstraint を作成します。開始位置は、クエリの順序に相対的です。ドキュメントには、クエリの orderBy で指定されたすべてのフィールドが含まれている必要があります。

署名:

export declare function startAfter<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;

パラメータ

戻り値:

QueryStartAtConstraint

query() に渡す QueryStartAtConstraint

startAt（スナップショット）

指定されたドキュメント（両端を含む）から開始するように結果セットを変更する QueryStartAtConstraint を作成します。開始位置は、クエリの順序に相対的です。ドキュメントには、このクエリの orderBy で指定されたすべてのフィールドが含まれている必要があります。

署名:

export declare function startAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;

パラメータ

戻り値:

QueryStartAtConstraint

query() に渡す QueryStartAtConstraint。

関数(値, ...)

ベクトル（値）

指定された数値配列のコピーで構築された新しい VectorValue を作成します。

署名:

export declare function vector(values?: number[]): VectorValue;

パラメータ

戻り値:

VectorValue

指定された数値配列のコピーで構築された新しい VectorValue。

CACHE_SIZE_UNLIMITED

LRU ガベージ コレクションを無効にする必要があることを示すために使用される定数。この値は、Firestore インスタンスに渡される設定の cacheSizeBytes として設定します。

署名:

CACHE_SIZE_UNLIMITED = -1

AddPrefixToKeys

すべてのキーの先頭に、ドットに付加された外側のキーが付いた新しいマップを返します。

署名:

export declare type AddPrefixToKeys<Prefix extends string, T extends Record<string, unknown>> = {
    [K in keyof T & string as `${Prefix}.${K}`]+?: string extends K ? any : T[K];
};

集計フィールド タイプ

Firestore でサポートされているすべての AggregateField 型の結合。

署名:

export declare type AggregateFieldType = ReturnType<typeof sum> | ReturnType<typeof average> | ReturnType<typeof count>;

AggregateSpecData

キーが AggregateSpec から取得され、その値は入力 AggregateSpec からの対応する AggregateField によって実行された集計の結果である型。

署名:

export declare type AggregateSpecData<T extends AggregateSpec> = {
    [P in keyof T]: T[P] extends AggregateField<infer U> ? U : never;
};

集計タイプ

実行する集計型を表す共用体型。

署名:

export declare type AggregateType = 'count' | 'avg' | 'sum';

ChildUpdateFields

指定された型 T1 のネストされたフィールドを計算するためのヘルパー。これは、undefined | {...}（オプションの prop で使用）や {a: A} | {b: B} などの共用体タイプを配布するために必要です。

このユースケースでは、T[K] は分散ではなく式として評価されるため、V を使用して Record の T[K] の共用体型を分散します。

https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-conditional-types をご覧ください。

署名:

export declare type ChildUpdateFields<K extends string, V> = V extends Record<string, unknown> ? AddPrefixToKeys<K, UpdateData<V>> : never;

DocumentChangeType

DocumentChange のタイプは、「追加」、「削除」、「変更」のいずれかです。

署名:

export declare type DocumentChangeType = 'added' | 'removed' | 'modified';

FirestoreErrorCode

Firestore ステータス コードのセット。コードは、gRPC によって公開されているコードと同じです: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

可能な値: - 'cancelled': オペレーションはキャンセルされました（通常は呼び出し元によって）。- 'unknown': 不明なエラーまたは別のエラードメインからのエラーです。- 'invalid-argument': クライアントが無効な引数を指定しました。これは「failed-precondition」とは異なることに注意してください。「無効な引数」は、システムの状態に関係なく問題がある引数を示します（無効なフィールド名など）。- 'deadline-exceeded': 操作が完了する前に期限が切れました。システムの状態を変更するオペレーションの場合、オペレーションが正常に終了しても、このエラーが返されることがあります。たとえば、サーバーからの正常なレスポンスが、期限切れになるほど遅延していた可能性があります。- 'not-found': リクエストされたドキュメントは見つかりませんでした。- 'Already-exists': 作成しようとしたドキュメントがすでに存在します。- 'permission-denied': 呼び出し元には、指定された操作を実行する権限がありません。- 'resource-exhausted': 一部のリソースが不足しています。ユーザーごとの割り当て、またはファイル システム全体で容量が不足している可能性があります。- 'failed-precondition': システムがオペレーションの実行に必要な状態ではないため、オペレーションが拒否されました。- 'aborted': オペレーションは中止されました。通常は、トランザクションの中止などの同時実行の問題が原因です。- 'out-of-range': オペレーションが有効な範囲を超えて試行されました。- 'unImplemented': オペレーションが実装されていないか、サポートまたは有効化されていません。- 'internal': 内部エラーです。基になるシステムで予期される一部の不変条件が破損していることを意味します。これらのエラーのいずれかが表示される場合、何かが著しく壊れています。- 「unavailable」: サービスは現在利用できません。これは一時的な状態である可能性が高く、バックオフで再試行することで修正できます。- 'data-loss': 回復不能なデータの損失または破損。- 'unauthenticated': リクエストに、操作のための有効な認証情報がありません。

署名:

export declare type FirestoreErrorCode = 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';

FirestoreLocalCache

サポートされているすべての SDK キャッシュ レイヤの共用体タイプ。

署名:

export declare type FirestoreLocalCache = MemoryLocalCache | PersistentLocalCache;

ListenSource

クエリがリッスンするソースを記述します。

キャッシュとサーバーの両方の変更をリッスンするには、default に設定します。キャッシュ内の変更のみをリッスンするには、cache に設定します。

署名:

export declare type ListenSource = 'default' | 'cache';

MemoryGarbageCollector

すべての統合タイプで、メモリ ローカル キャッシュのガベージ コレクタをサポート。

署名:

export declare type MemoryGarbageCollector = MemoryEagerGarbageCollector | MemoryLruGarbageCollector;

ネストされた更新フィールド

各フィールド（「bar」など）で、ネストされたキーをすべて検索します（例: {'bar.baz': T1, 'bar.qux': T2}）。それらのキーを組み合わせて 1 つのマップを作成します。このマップには、オプションとして指定されているキーをすべて含めます。

署名:

export declare type NestedUpdateFields<T extends Record<string, unknown>> = UnionToIntersection<{
    [K in keyof T & string]: ChildUpdateFields<K, T[K]>;
}[keyof T & string]>;

OrderByDirection

orderBy() 句の方向は「desc」として指定されます。または「asc」（降順または昇順）。

署名:

export declare type OrderByDirection = 'desc' | 'asc';

PartialWithFieldValue

TypeScript の Partial<T> に似ていますが、ネストされたフィールドを省略し、FieldValues をプロパティ値として渡すことができます。

署名:

export declare type PartialWithFieldValue<T> = Partial<T> | (T extends Primitive ? T : T extends {} ? {
    [K in keyof T]?: PartialWithFieldValue<T[K]> | FieldValue;
} : never);

PersistentTabManager

利用可能なすべてのタブ マネージャーをまとめたものです。

署名:

export declare type PersistentTabManager = PersistentSingleTabManager | PersistentMultipleTabManager;

基本ロール

プリミティブ型。

署名:

export declare type Primitive = string | number | boolean | undefined | null;

QueryConstraintType

この SDK で使用できるさまざまなクエリ制約について説明します。

署名:

export declare type QueryConstraintType = 'where' | 'orderBy' | 'limit' | 'limitToLast' | 'startAt' | 'startAfter' | 'endAt' | 'endBefore';

QueryFilterConstraints

QueryFilterConstraint は、QueryFieldFilterConstraint と QueryCompositeFilterConstraint を表すヘルパー ユニオン型です。

署名:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

QueryNonFilterConstraint

QueryNonFilterConstraint は、QueryConstraints を表すヘルパー ユニオン型です。これは、ドキュメント セットの絞り込みまたは並べ替えに使用されますが、ドキュメント フィールドで明示的にフィルタリングすることはありません。QueryNonFilterConstraint は、orderBy()、startAt()、startAfter()、endBefore()、endAt()、limit()、または limitToLast() を呼び出して、query() を含む新しいクエリ インスタンスを作成することで作成されます。QueryConstraint

署名:

export declare type QueryNonFilterConstraint = QueryOrderByConstraint | QueryLimitConstraint | QueryStartAtConstraint | QueryEndAtConstraint;

SetOptions

setDoc() の動作を設定して呼び出すオプション オブジェクト。これらの呼び出しは、SetOptions に merge: true を指定することで、ターゲット ドキュメント全体を上書きするのではなく、詳細なマージを実行するように構成できます。

署名:

export declare type SetOptions = {
    readonly merge?: boolean;
} | {
    readonly mergeFields?: Array<string | FieldPath>;
};

タスクの状態

バンドル読み込みタスクの状態を表します。

「エラー」とおよび「Success」シンク状態: タスクは中止または完了し、報告後は更新がそれ以上行われなくなります。

署名:

export declare type TaskState = 'Error' | 'Running' | 'Success';

UnionToIntersection

共用体型 U = T1 | T2 | ... の場合、交差型 (T1 & T2 & ...) を返します。

分布条件型と、条件型からの推論を使用します。反バリアント位置にある同じ型変数の候補が複数あると、交差点の型が推測されるため、これはうまくいきます。https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-union-type-to-intersection-type

署名:

export declare type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;