Firebase Database サービス インターフェース。@firebase/database-compat パッケージが提供する Database インターフェースを拡張します。
署名:
export interface Database extends FirebaseDatabase
拡張: FirebaseDatabase
方法
| メソッド | 説明 |
|---|---|
| getRules() | 現在適用されているセキュリティ ルールを文字列として取得します。戻り値は、コメントを含むルールソースで構成されます。 |
| getRulesJSON() | 現在適用されているセキュリティ ルールを、解析された JSON オブジェクトとして取得します。元のソースのコメントはすべて削除されます。 |
| setRules(ソース) | Firebase Realtime Database インスタンスに指定されたルールを設定します。ルールのソースが文字列またはバッファとして指定されている場合は、コメントを含めることができます。 |
Database.getRules()
現在適用されているセキュリティ ルールを文字列として取得します。戻り値は、コメントを含むルールソースで構成されます。
署名:
getRules(): Promise<string>;
戻り値:
Promise<文字列>
ルールによって履行された Promise（未加工の文字列）。
Database.getRulesJSON()
現在適用されているセキュリティ ルールを、解析された JSON オブジェクトとして取得します。元のソースのコメントはすべて削除されます。
署名:
getRulesJSON(): Promise<object>;
戻り値:
Promise<object>
解析されたルール オブジェクトによって処理された Promise。
Database.setRules()
Firebase Realtime Database インスタンスに指定されたルールを設定します。ルールのソースが文字列またはバッファとして指定されている場合は、コメントを含めることができます。
署名:
setRules(source: string | Buffer | object): Promise<void>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| target | 文字列 | バッファ | オブジェクト | 適用するルールのソース。null または空にすることはできません。 |
戻り値:
Promise
Realtime Database にルールが設定されていると解決します。