firebase-admin.security-rules package

Sicherheitsregeln für Cloud Firestore und Cloud Storage.

Funktionen

Funktion Beschreibung
getSecurityRules(app) Ruft den SecurityRules- Dienst für die Standard-App oder eine bestimmte App ab. admin.securityRules() kann ohne Argumente aufgerufen werden, um auf den SecurityRules Dienst der Standard-App zuzugreifen, oder als admin.securityRules(app) um auf den SecurityRules Dienst zuzugreifen, der einer bestimmten App zugeordnet ist.

Klassen

Klasse Beschreibung
Regelsatz Eine Reihe von Firebase-Sicherheitsregeln.
RulesetMetadataList Eine Seite mit Regelsatz-Metadaten.
Sicherheitsregeln Die Firebase SecurityRules Dienstschnittstelle.

Schnittstellen

Schnittstelle Beschreibung
RulesetMetadata Erforderliche Metadaten, die einem Regelsatz zugeordnet sind.
Regeldatei Eine Quelldatei, die einige Firebase-Sicherheitsregeln enthält. Der Inhalt umfasst rohen Quellcode einschließlich Textformatierung, Einrückungen und Kommentare. Verwenden Sie die Methode SecurityRules.createRulesFileFromSource() , um neue Instanzen dieses Typs zu erstellen.

getSecurityRules()

Ruft den SecurityRules- Dienst für die Standard-App oder eine bestimmte App ab.

admin.securityRules() kann ohne Argumente aufgerufen werden, um auf den SecurityRules Dienst der Standard-App zuzugreifen, oder als admin.securityRules(app) um auf den SecurityRules Dienst zuzugreifen, der einer bestimmten App zugeordnet ist.

Unterschrift:

export declare function getSecurityRules(app?: App): SecurityRules;

Parameter

Parameter Typ Beschreibung
App App Optionale App, für die der SecurityRules Dienst zurückgegeben werden soll. Wenn nicht angegeben, wird der standardmäßige SecurityRules Dienst zurückgegeben.

Kehrt zurück:

Sicherheitsregeln

Der standardmäßige SecurityRules Dienst, wenn keine App bereitgestellt wird, oder der SecurityRules Dienst, der der bereitgestellten App zugeordnet ist.

Beispiel 1

// Get the SecurityRules service for the default app
const defaultSecurityRules = getSecurityRules();

Beispiel 2

// Get the SecurityRules service for a given app
const otherSecurityRules = getSecurityRules(otherApp);