firestore namespace

関数

関数 説明
beforeSnapshotConstructor(event)
database(database)
ドキュメント（パス） イベントをリッスンする Firestore ドキュメントを選択します。
namespace(namespace)
snapshotConstructor(event)（スナップショットコンストラクタ（イベント））

クラス

クラス 説明
DatabaseBuilder
DocumentBuilder
NamespaceBuilder

型エイリアス

型エイリアス 説明
DocumentSnapshot
QueryDocumentSnapshot

firestore.beforeSnapshotConstructor()

署名:

export declare function beforeSnapshotConstructor(event: Event): DocumentSnapshot;

パラメータ

パラメータ 型 説明
event イベント

戻り値:

DocumentSnapshot

Firestore.database()

署名:

export declare function database(database: string): DatabaseBuilder;

パラメータ

パラメータ 型 説明
データベース 文字列

戻り値:

DatabaseBuilder

Firestore.document()

イベントをリッスンする Firestore ドキュメントを選択します。

署名:

export declare function document<Path extends string>(path: Path): DocumentBuilder<Path>;

パラメータ

パラメータ 型 説明
パス パス リッスンするデータベースの完全なパス。これには、ドキュメントが属するコレクションの名前も含まれます。たとえば、コレクション名が「users」の場合、ドキュメント名が「Ada」の場合、パスは「/users/Ada」となります。

戻り値:

DocumentBuilder<パス>

Firestore.namespace()

署名:

export declare function namespace(namespace: string): NamespaceBuilder;

パラメータ

パラメータ 型 説明
namespace 文字列

戻り値:

NamespaceBuilder

Firestore.snapshotConstructor()

署名:

export declare function snapshotConstructor(event: Event): DocumentSnapshot;

パラメータ

パラメータ 型 説明
event イベント

戻り値:

DocumentSnapshot

firestore.DocumentSnapshot

署名:

export type DocumentSnapshot = firestore.DocumentSnapshot;

firestore.QueryDocumentSnapshot

署名:

export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;