firebase-admin.security-rules package

Cloud Firestore 和 Cloud Storage 的安全规则。

函数

函数 说明
getSecurityRules(应用) 获取默认应用或指定应用的 SecurityRules 服务。无需参数即可调用 admin.securityRules(),以访问默认应用的 SecurityRules 服务;也可作为 admin.securityRules(app) 调用与特定应用关联的 SecurityRules 服务。

说明
规则集 一组 Firebase 安全规则。
RulesetMetadataList 规则集元数据页面。
安全规则 Firebase SecurityRules 服务接口。

接口

接口 说明
RulesetMetadata 与规则集关联的必需元数据。
RulesFile 包含一些 Firebase 安全规则的源文件。该内容包括原始源代码,包括文本格式、缩进和注释。使用 SecurityRules.createRulesFileFromSource() 方法创建此类型的新实例。

getSecurityRules(应用)

获取默认应用或指定应用的 SecurityRules 服务。

可以不使用任何参数调用 admin.securityRules() 来访问默认应用的 SecurityRules 服务,也可以通过调用 admin.securityRules(app) 的形式访问与特定应用关联的 SecurityRules 服务。

签名

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

参数

参数 类型 说明
应用 应用 要为其返回 SecurityRules 服务的可选应用。如果未提供,则返回默认的 SecurityRules 服务。

返回

安全规则

如果未提供任何应用,则为默认的 SecurityRules 服务,或与所提供的应用关联的 SecurityRules 服务。

示例 1

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

示例 2

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