Variables
app()
const app: (name?: string) => SandboxAdminApp;
As upstream admin.app(name?): the named app, or the default app.
Parameters
Returns
SandboxAdminApp
appCheck()
const appCheck: (app?: PyricAdminApp) => AppCheck;
Parameters
Returns
AppCheck
auth()
const auth: (app?: PyricAdminApp) => Auth;
Parameters
Returns
Auth
credential
const credential: {
applicationDefault: typeof applicationDefault;
cert: typeof cert;
refreshToken: typeof refreshToken;
};
Type Declaration
applicationDefault
applicationDefault: typeof applicationDefault;
cert
cert: typeof cert;
refreshToken
refreshToken: typeof refreshToken;
database
const database: (app?: PyricAdminApp) => Database & {
enableLogging: DeferredApi;
ServerValue: {
increment: (delta: number) => object;
TIMESTAMP: object;
};
};
Type Declaration
enableLogging
enableLogging: DeferredApi;
ServerValue
ServerValue: {
increment: (delta: number) => object;
TIMESTAMP: object;
};
ServerValue.increment()
readonly increment: (delta: number) => object;
Parameters
Returns
object
ServerValue.TIMESTAMP
readonly TIMESTAMP: object;
default
const default: {
ADMIN_APP_TARGET: typeof ADMIN_APP_TARGET;
app: (name?: string) => SandboxAdminApp;
appCheck: (app?: PyricAdminApp) => AppCheck;
apps: SandboxAdminApp[];
auth: (app?: PyricAdminApp) => Auth;
credential: {
applicationDefault: typeof applicationDefault;
cert: typeof cert;
refreshToken: typeof refreshToken;
};
database: (app?: PyricAdminApp) => Database & {
enableLogging: DeferredApi;
ServerValue: {
increment: (delta: number) => object;
TIMESTAMP: object;
};
};
DEFAULT_APP_NAME: "[DEFAULT]";
firestore: (app?: PyricAdminApp) => SandboxFirestore & {
AggregateField: DeferredApi;
FieldPath: typeof FieldPath;
FieldValue: typeof FieldValue;
Filter: DeferredApi;
GeoPoint: DeferredApi;
GrpcStatus: DeferredApi;
setLogFunction: DeferredApi;
Timestamp: typeof Timestamp;
};
installations: (app?: PyricAdminApp) => Installations;
instanceId: (app?: PyricAdminApp) => InstanceId;
machineLearning: (app?: PyricAdminApp) => MachineLearning;
messaging: (app?: PyricAdminApp) => Messaging;
projectManagement: (app?: PyricAdminApp) => ProjectManagement;
remoteConfig: (app?: PyricAdminApp) => RemoteConfig;
securityRules: (app?: PyricAdminApp) => SecurityRules;
storage: (app?: PyricAdminApp) => Storage;
applicationDefault: never;
cert: object;
deleteApp: Promise<void>;
getApp: SandboxAdminApp;
getApps: SandboxAdminApp[];
initializeApp: SandboxAdminApp;
isSandboxAdminApp: app is SandboxAdminApp;
refreshToken: object;
};
Type Declaration
ADMIN_APP_TARGET
ADMIN_APP_TARGET: typeof ADMIN_APP_TARGET;
app()
app: (name?: string) => SandboxAdminApp;
Parameters
Returns
SandboxAdminApp
appCheck()
appCheck: (app?: PyricAdminApp) => AppCheck;
Parameters
Returns
AppCheck
apps
apps: SandboxAdminApp[];
auth()
auth: (app?: PyricAdminApp) => Auth;
Parameters
Returns
Auth
credential
credential: {
applicationDefault: typeof applicationDefault;
cert: typeof cert;
refreshToken: typeof refreshToken;
};
credential.applicationDefault
applicationDefault: typeof applicationDefault;
credential.cert
cert: typeof cert;
credential.refreshToken
refreshToken: typeof refreshToken;
database
database: (app?: PyricAdminApp) => Database & {
enableLogging: DeferredApi;
ServerValue: {
increment: (delta: number) => object;
TIMESTAMP: object;
};
};
Type Declaration
DEFAULT_APP_NAME
DEFAULT_APP_NAME: "[DEFAULT]";
firestore
firestore: (app?: PyricAdminApp) => SandboxFirestore & {
AggregateField: DeferredApi;
FieldPath: typeof FieldPath;
FieldValue: typeof FieldValue;
Filter: DeferredApi;
GeoPoint: DeferredApi;
GrpcStatus: DeferredApi;
setLogFunction: DeferredApi;
Timestamp: typeof Timestamp;
};
Type Declaration
installations()
installations: (app?: PyricAdminApp) => Installations;
Parameters
Returns
Installations
instanceId()
instanceId: (app?: PyricAdminApp) => InstanceId;
Parameters
Returns
InstanceId
machineLearning()
machineLearning: (app?: PyricAdminApp) => MachineLearning;
Parameters
Returns
MachineLearning
messaging()
messaging: (app?: PyricAdminApp) => Messaging;
Parameters
Returns
Messaging
projectManagement()
projectManagement: (app?: PyricAdminApp) => ProjectManagement;
Parameters
Returns
ProjectManagement
remoteConfig()
remoteConfig: (app?: PyricAdminApp) => RemoteConfig;
Parameters
Returns
RemoteConfig
securityRules()
securityRules: (app?: PyricAdminApp) => SecurityRules;
Parameters
Returns
SecurityRules
storage()
storage: (app?: PyricAdminApp) => Storage;
Parameters
Returns
Storage
applicationDefault()
applicationDefault(): never;
Returns
never
cert()
cert(serviceAccountPathOrObject: unknown): object;
Parameters
Returns
object
deleteApp()
deleteApp(app: SandboxAdminApp): Promise<void>;
Parameters
Returns
Promise<void>
getApp()
getApp(name?: string): SandboxAdminApp;
Parameters
Returns
SandboxAdminApp
getApps()
getApps(): SandboxAdminApp[];
Returns
SandboxAdminApp[]
initializeApp()
initializeApp(config?:
| Record<string, unknown>
| InitializeAdminAppConfig, name?: string): SandboxAdminApp;
Parameters
Returns
SandboxAdminApp
isSandboxAdminApp()
isSandboxAdminApp(app: SandboxAdminApp): app is SandboxAdminApp;
Parameters
Returns
app is SandboxAdminApp
refreshToken()
refreshToken(_refreshTokenPathOrObject: unknown): object;
Parameters
Returns
object
firestore
const firestore: (app?: PyricAdminApp) => SandboxFirestore & {
AggregateField: DeferredApi;
FieldPath: typeof FieldPath;
FieldValue: typeof FieldValue;
Filter: DeferredApi;
GeoPoint: DeferredApi;
GrpcStatus: DeferredApi;
setLogFunction: DeferredApi;
Timestamp: typeof Timestamp;
};
Type Declaration
AggregateField
AggregateField: DeferredApi;
FieldPath
FieldPath: typeof FieldPath;
FieldValue
FieldValue: typeof FieldValue;
Filter
Filter: DeferredApi;
GeoPoint
GeoPoint: DeferredApi;
GrpcStatus
GrpcStatus: DeferredApi;
setLogFunction
setLogFunction: DeferredApi;
Timestamp
Timestamp: typeof Timestamp;
installations()
const installations: (app?: PyricAdminApp) => Installations;
Parameters
Returns
Installations
instanceId()
const instanceId: (app?: PyricAdminApp) => InstanceId;
Parameters
Returns
InstanceId
machineLearning()
const machineLearning: (app?: PyricAdminApp) => MachineLearning;
Parameters
Returns
MachineLearning
messaging()
const messaging: (app?: PyricAdminApp) => Messaging;
Parameters
Returns
Messaging
projectManagement()
const projectManagement: (app?: PyricAdminApp) => ProjectManagement;
Parameters
Returns
ProjectManagement
remoteConfig()
const remoteConfig: (app?: PyricAdminApp) => RemoteConfig;
Parameters
Returns
RemoteConfig
securityRules()
const securityRules: (app?: PyricAdminApp) => SecurityRules;
Parameters
Returns
SecurityRules
storage()
const storage: (app?: PyricAdminApp) => Storage;
Parameters
Returns
Storage
References
ADMIN_APP_TARGET
Re-exports ADMIN_APP_TARGET
AdminAppOptions
Re-exports AdminAppOptions
applicationDefault
Re-exports applicationDefault
cert
Re-exports cert
DEFAULT_APP_NAME
Re-exports DEFAULT_APP_NAME
deleteApp
Re-exports deleteApp
getApp
Re-exports getApp
getApps
Re-exports getApps
InitializeAdminAppConfig
Re-exports InitializeAdminAppConfig
initializeApp
Re-exports initializeApp
isSandboxAdminApp
Re-exports isSandboxAdminApp
PyricAdminApp
Re-exports PyricAdminApp
PyricAdminAppTarget
Re-exports PyricAdminAppTarget
refreshToken
Re-exports refreshToken
SandboxAdminApp
Re-exports SandboxAdminApp