51 lines
1.8 KiB
TypeScript
51 lines
1.8 KiB
TypeScript
|
/*! firebase-admin v11.0.1 */
|
||
|
|
/*!
|
||
|
|
* Copyright 2020 Google Inc.
|
||
|
|
*
|
||
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
* you may not use this file except in compliance with the License.
|
||
|
|
* You may obtain a copy of the License at
|
||
|
|
*
|
||
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
*
|
||
|
|
* Unless required by applicable law or agreed to in writing, software
|
||
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
* See the License for the specific language governing permissions and
|
||
|
|
* limitations under the License.
|
||
|
|
*/
|
||
|
|
/**
|
||
|
|
* Security Rules for Cloud Firestore and Cloud Storage.
|
||
|
|
*
|
||
|
|
* @packageDocumentation
|
||
|
|
*/
|
||
|
|
import { App } from '../app';
|
||
|
|
import { SecurityRules } from './security-rules';
|
||
|
|
export { RulesFile, Ruleset, RulesetMetadata, RulesetMetadataList, SecurityRules, } from './security-rules';
|
||
|
|
/**
|
||
|
|
* Gets the {@link SecurityRules} service for the default app or a given app.
|
||
|
|
*
|
||
|
|
* `admin.securityRules()` can be called with no arguments to access the
|
||
|
|
* default app's `SecurityRules` service, or as `admin.securityRules(app)` to access
|
||
|
|
* the `SecurityRules` service associated with a specific app.
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* ```javascript
|
||
|
|
* // Get the SecurityRules service for the default app
|
||
|
|
* const defaultSecurityRules = getSecurityRules();
|
||
|
|
* ```
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* ```javascript
|
||
|
|
* // Get the SecurityRules service for a given app
|
||
|
|
* const otherSecurityRules = getSecurityRules(otherApp);
|
||
|
|
* ```
|
||
|
|
*
|
||
|
|
* @param app - Optional app to return the `SecurityRules` service
|
||
|
|
* for. If not provided, the default `SecurityRules` service
|
||
|
|
* is returned.
|
||
|
|
* @returns The default `SecurityRules` service if no app is provided, or the
|
||
|
|
* `SecurityRules` service associated with the provided app.
|
||
|
|
*/
|
||
|
|
export declare function getSecurityRules(app?: App): SecurityRules;
|