@firebase/firestore/lite

機能

クラス

インターフェース

タイプエイリアス

関数(アプリ、...)

getFirestore(アプリ)

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

サイン：

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

パラメーター

戻り値：

ファイヤーストア

提供されたアプリのFirestoreインスタンス。

getFirestore(アプリ、データベースID)

この API は開発者向けのプレビューとして提供されており、受け取ったフィードバックに基づいて変更される可能性があります。この API は実稼働環境では使用しないでください。

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

サイン：

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

パラメーター

戻り値：

ファイヤーストア

提供されたアプリのFirestoreインスタンス。

初期化Firestore(アプリ、設定)

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

サイン：

export declare function initializeFirestore(app: FirebaseApp, settings: Settings): Firestore;

パラメーター

戻り値：

ファイヤーストア

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

InitializeFirestore(アプリ、設定、データベースID)

この API は開発者向けのプレビューとして提供されており、受け取ったフィードバックに基づいて変更される可能性があります。この API は実稼働環境では使用しないでください。

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

サイン：

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

パラメーター

戻り値：

ファイヤーストア

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

関数(firestore, ...)

コレクション(firestore, path, pathSegments)

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

サイン：

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

パラメーター

戻り値：

コレクションリファレンス<ドキュメントデータ、ドキュメントデータ>

CollectionReferenceインスタンス。

例外

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

collectionGroup(firestore, collectionId)

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

サイン：

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

パラメーター

戻り値：

クエリ<ドキュメントデータ、ドキュメントデータ>

作成されたQuery 。

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

Cloud Firestore エミュレータと通信するようにこのインスタンスを変更します。

サイン：

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

パラメーター

戻り値：

空所

doc（ファイヤーストア、パス、パスセグメント）

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

サイン：

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

パラメーター

戻り値：

ドキュメントリファレンス< documentData 、 documentdata >

DocumentReferenceインスタンス。

例外

最終パスに奇数のセグメントがあり、ドキュメントを指していない場合。

RunTransaction（Firestore、UpdateFunction、Options）

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

単一のトランザクションで許可されている最大数は500です。

サイン：

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

パラメーター

戻り値：

約束<t>

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

終了（ファイヤーストア）

提供されたFirestoreインスタンスを終了します。

clearIndexedDbPersistence() terminate()のみを呼び出した後も使用できます。他の機能はFirestoreErrorを投げます。終了は保留中の書き込みをキャンセルせず、サーバーからの応答を待っている約束は解決されません。

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

サイン：

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

パラメーター

戻り値：

約束<無効>

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

WriteBatch（Firestore）

単一の原子操作として複数の書き込みを実行するために使用される書き込みバッチを作成します。単一の書き込みバッチで許可されている最大数の書き込みは500です。

これらの書き込みの結果は、返された約束が解決した後に発生するドキュメント読み取りにのみ反映されます。クライアントがオフラインの場合、書き込みは失敗します。クライアントがオンラインになるまでローカルの変更やバッファーの書き込みをご覧になりたい場合は、Firestore SDKを使用してください。

サイン：

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

パラメーター

戻り値：

書き込みバッチ

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

関数（）

カウント（）

クエリの結果セットでドキュメントのカウントを計算するために使用できる集約フィールドオブジェクトを作成します。

サイン：

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

戻り値：

アグリゲートフィールド<number>

deletefield（）

削除のフィールドをマークするために、 {merge: true}を使用してupdatedoc（）またはsetdoc（）で使用するためにセンチネルを返します。

サイン：

export declare function deleteField(): FieldValue;

戻り値：

FieldValue

documentid（）

ドキュメントのIDを参照するために、特別なSentinel FieldPathを返します。ドキュメントIDでソートまたはフィルタリングするためにクエリで使用できます。

サイン：

export declare function documentId(): FieldPath;

戻り値：

フィールドパス

getFirestore（）

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

サイン：

export declare function getFirestore(): Firestore;

戻り値：

ファイヤーストア

提供されたアプリのファイヤーストアインスタンス。

サーバータイムスタンプ()

setdoc（）またはupdatedoc（）で使用されたセンチネルを返して、書かれたデータにサーバーで生成されたタイムスタンプを含めます。

サイン：

export declare function serverTimestamp(): FieldValue;

戻り値：

FieldValue

function（databaseid、...）

getFirestore（databaseid）

このAPIは、開発者のプレビューとして提供されており、受け取ったフィードバックに基づいて変更される場合があります。このAPIを生産環境で使用しないでください。

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

サイン：

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

パラメーター

戻り値：

ファイヤーストア

提供されたアプリのファイヤーストアインスタンス。

関数（要素、...）

arrayremove（要素）

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

サイン：

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

パラメーター

戻り値：

FieldValue

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

arrayunion（要素）

サーバーに既に存在する配列値と特定の要素を結合するようにサーバーに指示するsetDoc（）またはupdatedoc（）で使用できる特別な値を返します。アレイにまだ存在しない指定された各要素は、最後まで追加されます。変更されているフィールドがまだ配列でない場合、指定された要素を正確に含む配列が上書きされます。

サイン：

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

パラメーター

戻り値：

FieldValue

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

関数（フィールド、...）

平均（フィールド）

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

サイン：

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

パラメーター

戻り値：

アグリゲートフィールド<番号| null>

sum（field）

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

サイン：

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

パラメーター

戻り値：

アグリゲートフィールド<number>

関数（FieldPath、...）

Orderby（FieldPath、DirectionStr）

QueryOrderByConstraintを作成します。これにより、指定されたフィールドでクエリの結果をソートします。

サイン：

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

パラメーター

戻り値：

QueryOrderByConstraint

作成されたQueryOrderByConstraint 。

WHERE（FieldPath、Opstr、Value）

ドキュメントに指定されたフィールドが含まれている必要があり、値が提供された関係の制約を満たす必要があることを強制するQueryFieldFilterConstraintを作成します。

サイン：

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

パラメーター

戻り値：

QueryFieldFilterConstraint

作成されたQueryFieldFilterConstraint 。

関数（FieldValues、...）

Endat（FieldValues）

クエリの順序に対して提供されたフィールドで終了する結果を変更するQueryEndatConstraintを作成します。フィールド値の順序は、クエリの条項によって注文の順序と一致する必要があります。

サイン：

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

パラメーター

戻り値：

queryendatconstraint

queryendatconstraint query()に渡す

endbefore（fieldvalues）

クエリの順序に対して、提供されたフィールドの前に終了する結果を変更するQueryEndatConstraintを作成します。フィールド値の順序は、クエリの条項によって注文の順序と一致する必要があります。

サイン：

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

パラメーター

戻り値：

queryendatconstraint

queryendatconstraint query()に渡す

start（fieldvalues）

クエリの順序に対して提供されたフィールドの後に起動する結果セットを変更するqueryStartAtConstraintを作成します。フィールド値の順序は、クエリの条項によって注文の順序と一致する必要があります。

サイン：

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

パラメーター

戻り値：

querystartatconstraint

querystartatconstraint query()に渡す

startat（fieldvalues）

クエリの順序に対して提供されたフィールドから開始する結果セットを変更するquerystartatconstraintを作成します。フィールド値の順序は、クエリの条項によって注文の順序と一致する必要があります。

サイン：

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

パラメーター

戻り値：

querystartatconstraint

querystartatconstraint query()に渡す。

関数（左、...）

aggregatefieldequal（左、右）

2つの 'AggregateFieldを比較します`平等のためのインスタンス。

サイン：

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

パラメーター

戻り値：

ブール値

aggregatequerysnapshotequal（左、右）

平等については、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;

パラメーター

戻り値：

ブール値

上記のように、オブジェクトが「等しい」、またはそれ以外の場合はfalseの場合はtrue 。

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。

関数(制限, ...)

制限（制限）

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

サイン：

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

パラメーター

戻り値：

querylimitconstraint

作成されたquerylimitconstraint 。

最後までの制限(制限)

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

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

サイン：

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

パラメーター

戻り値：

querylimitconstraint

作成されたquerylimitconstraint 。

関数（loglevel、...）

setloglevel（loglevel）

クラウドファイアストアログの冗長性（デバッグ、エラー、またはサイレント）を設定します。

サイン：

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

パラメーター

戻り値：

空所

関数（n、...）

増分（n）

SetDoc（）またはupdatedoc（）で使用できる特別な値を返し、サーバーに指定された値によってフィールドの現在の値を増分するように指示します。

オペランドまたは現在のフィールド値がフローティングポイント精度を使用する場合、すべての算術はIEEE 754セマンティクスに従います。両方の値が整数である場合、JavaScriptの安全な数値範囲の外側の値（ Number.MIN_SAFE_INTEGER to Number.MAX_SAFE_INTEGER ）また、精密損失の対象となります。さらに、Firestoreバックエンドで処理されると、すべての整数操作が-2^63から2^63-1の間に上限になります。

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

サイン：

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

パラメーター

戻り値：

FieldValue

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

関数(クエリ、...)

getAggregate（query、aggregatespec）

実際にドキュメントをダウンロードすることなく、指定されたクエリの結果セットのドキュメント上の指定された集約を計算します。

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

サイン：

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

パラメーター

戻り値：

約束< aggregatequerysnapshot <AggregateSpectype、AppModelType、dbmodelType >>

例

const aggregateSnapshot = await getAggregate(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;

getCount（Query）

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

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

サイン：

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

パラメーター

戻り値：

約束< aggregatequerysnapshot <{count： aggregatefield <number>; }、appModelType、dbmodelType >>

カウントで解決される約束。カウントはsnapshot.data().count 、 snapshotは、返された約束が解決するAggregateQuerySnapshotです。

getDocs（クエリ）

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

クエリが以前に実行された場合でも、すべてのクエリはサーバーによって直接実行されます。最近の変更は、バックエンドによってすでに適用されている場合にのみ、取得された結果に反映されています。クライアントがオフラインの場合、操作に失敗します。以前にキャッシュされた結果とローカルの変更を確認するには、Firesstore SDK全体を使用してください。

サイン：

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

パラメーター

戻り値：

約束< querysnapshot <AppModelType、DbModelType>>

クエリの結果とともに解決される約束。

クエリ（クエリ、compositefilter、queryconstraints）

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

サイン：

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

パラメーター

戻り値：

クエリ<AppModelType、DbModelType>

例外

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

クエリ(クエリ、クエリ制約)

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

サイン：

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

パラメーター

戻り値：

クエリ<AppModelType、DbModelType>

例外

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

関数（queryconstraints、...）

および（queryconstraints）

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

サイン：

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

パラメーター

戻り値：

querycompositefilterconstraint

新しく作成されたQueryCompositeFilterConstraint 。

または（queryconstraints）

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

サイン：

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

パラメーター

戻り値：

querycompositefilterconstraint

新しく作成されたQueryCompositeFilterConstraint 。

関数（参照、...）

adddoc（参照、データ）

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

この書き込みの結果は、返された約束が解決した後に発生するドキュメント読み取りにのみ反映されます。クライアントがオフラインの場合、書き込みは失敗します。クライアントがオンラインになるまでローカルの変更やバッファーの書き込みをご覧になりたい場合は、Firestore SDKを使用してください。

サイン：

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

パラメーター

戻り値：

約束< documentReference <AppModelType、DbModelType>>

バックエンドに書き込まれた後、新しく作成されたドキュメントを指すDocumentReferenceで解決されたPromise 。

例外

エラー - 指定された入力が有効な Firestore ドキュメントではない場合。

コレクション（リファレンス、パス、パスセグメント）

指定された相対パスでの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が参照されるドキュメントを削除します。

削除は、返された約束が解決した後に発生するドキュメント読み取りにのみ反映されます。クライアントがオフラインの場合、削除は失敗します。クライアントがオンラインになるまでローカルの変更やバッファーの書き込みをご覧になりたい場合は、Firestore SDKを使用してください。

サイン：

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

パラメーター

戻り値：

約束<無効>

ドキュメントがバックエンドから正常に削除されると、 Promiseが解決されました。

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

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

サイン：

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

パラメーター

戻り値：

ドキュメントリファレンス<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>;

パラメーター

戻り値：

ドキュメントリファレンス< documentData 、 documentdata >

DocumentReferenceインスタンス。

例外

最終パスに奇数のセグメントがあり、ドキュメントを指していない場合。

getDoc（参照）

指定されたドキュメントリファレンスで言及されているドキュメントを読み取ります。

ドキュメントが以前に読み取られたり変更されていた場合でも、すべてのドキュメントはサーバーから直接フェッチされます。最近の変更は、バックエンドによってすでに適用されている場合にのみ、取得されたDocumentSnapshotに反映されています。クライアントがオフラインの場合、読み取りが失敗します。キャッシュを使用したり、ローカルの変更をご覧になりたい場合は、Firestore SDKを使用してください。

サイン：

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

パラメーター

戻り値：

Promise< DocumentSnapshot <AppModelType、DbModelType>>

現在のドキュメントコンテンツを含むDocumentSnapshotで解決された約束。

setdoc（参照、データ）

指定されたDocumentReferenceが参照された文書に書き込み。ドキュメントがまだ存在しない場合、それは作成されます。

この書き込みの結果は、返された約束が解決した後に発生するドキュメント読み取りにのみ反映されます。クライアントがオフラインの場合、書き込みは失敗します。クライアントがオンラインになるまでローカルの変更やバッファーの書き込みをご覧になりたい場合は、Firestore SDKを使用してください。

サイン：

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

パラメーター

戻り値：

約束<無効>

データがバックエンドに正常に書き込まれると、 Promiseが解決されました。

例外

エラー - 指定された入力が有効な Firestore ドキュメントではない場合。

SetDoc（参照、データ、オプション）

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

この書き込みの結果は、返された約束が解決した後に発生するドキュメント読み取りにのみ反映されます。クライアントがオフラインの場合、書き込みは失敗します。クライアントがオンラインになるまでローカルの変更やバッファーの書き込みをご覧になりたい場合は、Firestore SDKを使用してください。

サイン：

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

パラメーター

戻り値：

約束<無効>

データがバックエンドに正常に書き込まれると、 Promiseが解決されました。

例外

エラー - 指定された入力が有効な Firestore ドキュメントではない場合。

updatedoc（参照、データ）

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

この更新の結果は、返された約束が解決した後に発生するドキュメント読み取りにのみ反映されます。クライアントがオフラインの場合、更新は失敗します。クライアントがオンラインになるまでローカルの変更やバッファーの書き込みをご覧になりたい場合は、Firestore SDKを使用してください。

サイン：

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

パラメーター

戻り値：

約束<無効>

データがバックエンドに正常に書き込まれると、 Promiseが解決されました。

例外

エラー - 指定された入力が有効な Firestore データではない場合。

updatedoc（参照、フィールド、値、モアフィールドサンドバル）

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

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

この更新の結果は、返された約束が解決した後に発生するドキュメント読み取りにのみ反映されます。クライアントがオフラインの場合、更新は失敗します。クライアントがオンラインになるまでローカルの変更やバッファーの書き込みをご覧になりたい場合は、Firestore SDKを使用してください。

サイン：

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

パラメーター

戻り値：

約束<無効>

データがバックエンドに正常に書き込まれると、 Promiseが解決されました。

例外

エラー - 指定された入力が有効な Firestore データではない場合。

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

Endat（スナップショット）

提供されたドキュメント（包括的）で終了する結果を変更するqueryendatconstraintを作成します。終了位置は、クエリの順序に関連しています。ドキュメントには、クエリの順序で提供されるすべてのフィールドを含める必要があります。

サイン：

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

パラメーター

戻り値：

queryendatconstraint

queryendatconstraint query()に渡す

endbefore（snapshot）

提供されたドキュメント（排他的）の前に結果を終了する結果を変更するQueryEndatConstraintを作成します。終了位置は、クエリの順序に関連しています。ドキュメントには、クエリの順序で提供されるすべてのフィールドを含める必要があります。

サイン：

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

パラメーター

戻り値：

queryendatconstraint

queryendatconstraint query()に渡す

start after（snapshot）

提供されたドキュメント（排他的）の後に起動する結果セットを変更するqueryStartAtConstraintを作成します。開始位置は、クエリの順序に関連しています。ドキュメントには、クエリの順序で提供されるすべてのフィールドを含める必要があります。

サイン：

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

パラメーター

戻り値：

querystartatconstraint

querystartatconstraint query()に渡す

startat（snapshot）

QueryStartAtConstraintを作成し、結果設定された結果を変更して、提供されたドキュメント（包括的）で開始します。開始位置は、クエリの順序に関連しています。このドキュメントには、このクエリのorderByで提供されるすべてのフィールドを含める必要があります。

サイン：

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

パラメーター

戻り値：

querystartatconstraint

querystartatconstraint query()に渡す。

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];
};

AggregateFieldType

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;
};

AggregateType

実行される骨材タイプを表すユニオンタイプ。

サイン：

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

ChildUpdateFields

特定のタイプT1のネストされたフィールドを計算するためのヘルパー。これは、 undefined | {...} （オプションの小道具で発生）または{a: A} | {b: B} 。

このユースケースでは、 V Record上のユニオンタイプのT[K]を配布するために使用されます、 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;

firestoreerrorcode

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

可能な値： - 「キャンセル」：操作はキャンセルされました（通常は発信者によって）。 - 「不明」：異なるエラードメインからの不明なエラーまたはエラー。 - 'invalid-argument'：クライアントは無効な引数を指定しました。これは「失敗した前提条件」とは異なることに注意してください。 「Invalid-Argument」は、システムの状態に関係なく問題がある引数を示します（たとえば、無効なフィールド名）。 - 「締め切り」：操作が完了する前に期限が切れた締め切り。システムの状態を変更する操作の場合、操作が正常に完了した場合でも、このエラーが返される場合があります。たとえば、サーバーからの応答の成功は、期限が切れるのに十分長く遅れていた可能性があります。 - 'not-found'：要求されたドキュメントは見つかりませんでした。 - 「すでに存在する」：作成を試みた文書が既に存在します。 - 「許可-Denied」：発信者は、指定された操作を実行する許可を持っていません。 - 「Resource-Execresd」：一部のリソースは使い果たされており、おそらくユーザーごとのクォータ、またはファイルシステム全体がスペースが外れています。 - 「失敗前処理」：システムが操作の実行に必要な状態にないため、操作は拒否されました。 - 「中止」：通常、トランザクション中断などの並行性の問題が原因で、操作は中止されました。 - 「実装されていない」：操作は実装されていないか、サポート/有効化されていません。 - 「内部」：内部エラー。基礎となるシステムによって予想されるいくつかの侵略が壊れていることを意味します。これらのエラーのいずれかが表示されている場合、何かが非常に壊れています。 - 「利用できない」：サービスは現在利用できません。これはおそらく一時的な状態であり、バックオフで再試行することで修正される場合があります。 - 「データロス」：回復不可能なデータ損失または腐敗。 - 「認証されていない」：リクエストには、操作の有効な認証資格情報がありません。

サイン：

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';

NestedUpDateFields

各フィールド（例： 'bar'）について、すべてのネストされたキーを見つけます（例：{ 'bar.baz'：t1、 'bar.qux'：t2 } ）。それらと交差して、すべてオプションとしてマークされたすべての可能なキーを含む単一のマップを作成します

サイン：

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';

部分的フィールド値あり

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

サイン：

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

原生的

プリミティブタイプ。

サイン：

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

クエリ制約タイプ

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

サイン：

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

QueryFilterConstraint

QueryFilterConstraint 、 queryfieldfilterconstraintとquerycompositefilterconstraintを表すヘルパーユニオンタイプです。

サイン：

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

querynonfilterconstraint

QueryNonFilterConstraint 、ドキュメントのセットを絞り込んだり注文したりするために使用されるQueryConstraintsを表すヘルパーユニオンタイプですが、ドキュメントフィールドで明示的にフィルタリングしません。 QueryNonFilterConstraint sはorderby（）を呼び出すことによって作成されます、 startAt() 、 startAfter() 、 endBefore() 、 endat（） 、 limit（）またはlimittolast（）をQueryConstraint （）に渡すことができます。 。

サイン：

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

オプションの設定

setdoc（）の動作を構成するオプションオブジェクト、および電話。これらの呼び出しは、ターゲットドキュメント全体を上書きするのではなく、 SetOptions合併を実行するように構成できますmerge: true 。

サイン：

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

ユニオンインターセクション

ユニオンタイプU = T1 | T2 | ...が与えられますU = T1 | T2 | ... 、交差したタイプ(T1 & T2 & ...)を返します。

分配条件付きタイプと条件付きタイプからの推論を使用します。これは、対照的位置の同じタイプ変数の複数の候補が交差タイプを推測するためです。 https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-in​​ference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-union-typeto-intersection -タイプ

サイン：

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

データの更新

データを更新する（ updatedoc（）で使用するため）値にマッピングされたフィールドパス（「foo」または「foo.baz」など）で構成されています。ドットを含むフィールドは、ドキュメント内のネストされたフィールドを参照します。 FieldValuesは、プロパティ値として渡すことができます。

サイン：

export declare type UpdateData<T> = T extends Primitive ? T : T extends {} ? {
    [K in keyof T]?: UpdateData<T[K]> | FieldValue;
} & NestedUpdateFields<T> : Partial<T>;

wherefilterop

where（）句のフィルター条件は、文字列 '＆lt;'、 '＆lt; ='、 '=='、 '！='、 '＆gt; ='、 '＆gt;'、 'array-contains'を使用して指定されています。 、 'in'、 'array-contains-any'、および 'not-in'。

サイン：

export declare type WhereFilterOp = '<' | '<=' | '==' | '!=' | '>=' | '>' | 'array-contains' | 'in' | 'array-contains-any' | 'not-in';

フィールド値あり

タイプの安全性を維持しながら、フィールド値をプロパティ値として渡すことができます。

サイン：

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