UNPKG

1.88 kBTypeScriptView Raw
1/*! firebase-admin v10.0.0 */
2/*!
3 * Copyright 2020 Google Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17/**
18 * Security Rules for Cloud Firestore and Cloud Storage.
19 *
20 * @packageDocumentation
21 */
22import { App } from '../app';
23import { SecurityRules } from './security-rules';
24export { RulesFile, Ruleset, RulesetMetadata, RulesetMetadataList, SecurityRules, } from './security-rules';
25/**
26 * Gets the {@link SecurityRules} service for the default app or a given app.
27 *
28 * `admin.securityRules()` can be called with no arguments to access the
29 * default app's `SecurityRules` service, or as `admin.securityRules(app)` to access
30 * the `SecurityRules` service associated with a specific app.
31 *
32 * @example
33 * ```javascript
34 * // Get the SecurityRules service for the default app
35 * const defaultSecurityRules = getSecurityRules();
36 * ```
37 *
38 * @example
39 * ```javascript
40 * // Get the SecurityRules service for a given app
41 * const otherSecurityRules = getSecurityRules(otherApp);
42 * ```
43 *
44 * @param app - Optional app to return the `SecurityRules` service
45 * for. If not provided, the default `SecurityRules` service
46 * is returned.
47 * @returns The default `SecurityRules` service if no app is provided, or the
48 * `SecurityRules` service associated with the provided app.
49 */
50export declare function getSecurityRules(app?: App): SecurityRules;