Realtime Database や Cloud Firestore の onWrite
イベントや onUpdate
イベントなど、状態を変更するイベント用の Cloud Functions インターフェース。
Change
オブジェクトの作成に使用される形式について詳しくは、以下をご覧ください。
署名:
export declare class Change<T>
コンストラクタ
コンストラクタ | 修飾キー | 説明 |
---|---|---|
(コンストラクタ)(before, after) | Change クラスの新しいインスタンスを作成します。 |
プロパティ
プロパティ | 修飾キー | タイプ | 説明 |
---|---|---|---|
変更後 | T | ||
変更前 | T |
メソッド
メソッド | 修飾キー | 説明 |
---|---|---|
fromJSON(json, カスタマイザ) | static |
JSON から Change を作成するためのファクトリ メソッドと、before フィールドと after フィールドの両方に適用されるオプションのカスタマイザ関数。 |
fromObjects(before, after) | static |
before オブジェクトと after オブジェクトから Change を作成するためのファクトリ メソッド。 |
firestore.Change.(コンストラクタ)
Change
クラスの新しいインスタンスを作成します。
署名:
constructor(before: T, after: T);
パラメータ
パラメータ | 型 | 説明 |
---|---|---|
右以前 | T | |
右以降 | T |
firestore.Change.after
署名:
after: T;
firestore.Change.before
署名:
before: T;
firestore.Change.fromJSON()
JSON から Change
を作成するためのファクトリ メソッドと、before
フィールドと after
フィールドの両方に適用されるオプションのカスタマイザ関数。
署名:
static fromJSON<T>(json: ChangeJson, customizer?: (x: any) => T): Change<T>;
パラメータ
パラメータ | 型 | 説明 |
---|---|---|
json | ChangeJson | |
カスタマイザ | (x: 任意) =>木 |
戻り値:
変更<T>
firestore.Change.fromObjects()
before
オブジェクトと after
オブジェクトから Change
を作成するためのファクトリ メソッド。
署名:
static fromObjects<T>(before: T, after: T): Change<T>;
パラメータ
パラメータ | 型 | 説明 |
---|---|---|
右以前 | T | |
右以降 | T |
戻り値:
変更<T>