forked from firebase/firebase-admin-node
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.ts
More file actions
67 lines (62 loc) · 2.07 KB
/
index.ts
File metadata and controls
67 lines (62 loc) · 2.07 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
/*!
* 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, getApp } from '../app';
import { FirebaseApp } from '../app/firebase-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 function getSecurityRules(app?: App): SecurityRules {
if (typeof app === 'undefined') {
app = getApp();
}
const firebaseApp: FirebaseApp = app as FirebaseApp;
return firebaseApp.getOrInitService('securityRules', (app) => new SecurityRules(app));
}