Navigate

API reference

pyric-admin

30 published symbols from pyric-admin

Generated from the TypeScript declarations shipped at this import path.

Variables

app()

const app: (name?: string) => SandboxAdminApp;

As upstream admin.app(name?): the named app, or the default app.

Parameters

ParameterType
name?string

Returns

SandboxAdminApp


appCheck()

const appCheck: (app?: PyricAdminApp) => AppCheck;

Parameters

ParameterType
app?PyricAdminApp

Returns

AppCheck


auth()

const auth: (app?: PyricAdminApp) => Auth;

Parameters

ParameterType
app?PyricAdminApp

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
ParameterType
deltanumber
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
ParameterType
name?string
Returns

SandboxAdminApp

appCheck()
appCheck: (app?: PyricAdminApp) => AppCheck;
Parameters
ParameterType
app?PyricAdminApp
Returns

AppCheck

apps
apps: SandboxAdminApp[];

auth()
auth: (app?: PyricAdminApp) => Auth;
Parameters
ParameterType
app?PyricAdminApp
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
NameType
enableLoggingDeferredApi
ServerValue{ increment: (delta: number) => object; TIMESTAMP: object; }
ServerValue.increment()(delta: number) => object
ServerValue.TIMESTAMPobject

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
NameType
AggregateFieldDeferredApi
FieldPathtypeof FieldPath
FieldValuetypeof FieldValue
FilterDeferredApi
GeoPointDeferredApi
GrpcStatusDeferredApi
setLogFunctionDeferredApi
Timestamptypeof Timestamp

installations()
installations: (app?: PyricAdminApp) => Installations;
Parameters
ParameterType
app?PyricAdminApp
Returns

Installations

instanceId()
instanceId: (app?: PyricAdminApp) => InstanceId;
Parameters
ParameterType
app?PyricAdminApp
Returns

InstanceId

machineLearning()
machineLearning: (app?: PyricAdminApp) => MachineLearning;
Parameters
ParameterType
app?PyricAdminApp
Returns

MachineLearning

messaging()
messaging: (app?: PyricAdminApp) => Messaging;
Parameters
ParameterType
app?PyricAdminApp
Returns

Messaging

projectManagement()
projectManagement: (app?: PyricAdminApp) => ProjectManagement;
Parameters
ParameterType
app?PyricAdminApp
Returns

ProjectManagement

remoteConfig()
remoteConfig: (app?: PyricAdminApp) => RemoteConfig;
Parameters
ParameterType
app?PyricAdminApp
Returns

RemoteConfig

securityRules()
securityRules: (app?: PyricAdminApp) => SecurityRules;
Parameters
ParameterType
app?PyricAdminApp
Returns

SecurityRules

storage()
storage: (app?: PyricAdminApp) => Storage;
Parameters
ParameterType
app?PyricAdminApp
Returns

Storage

applicationDefault()
applicationDefault(): never;
Returns

never

cert()
cert(serviceAccountPathOrObject: unknown): object;
Parameters
ParameterType
serviceAccountPathOrObjectunknown
Returns

object

deleteApp()
deleteApp(app: SandboxAdminApp): Promise<void>;
Parameters
ParameterType
appSandboxAdminApp
Returns

Promise<void>

getApp()
getApp(name?: string): SandboxAdminApp;
Parameters
ParameterType
name?string
Returns

SandboxAdminApp

getApps()
getApps(): SandboxAdminApp[];
Returns

SandboxAdminApp[]

initializeApp()
initializeApp(config?:
  | Record<string, unknown>
  | InitializeAdminAppConfig, name?: string): SandboxAdminApp;
Parameters
ParameterType
config?| Record<string, unknown> | InitializeAdminAppConfig
name?string
Returns

SandboxAdminApp

isSandboxAdminApp()
isSandboxAdminApp(app: SandboxAdminApp): app is SandboxAdminApp;
Parameters
ParameterType
appSandboxAdminApp
Returns

app is SandboxAdminApp

refreshToken()
refreshToken(_refreshTokenPathOrObject: unknown): object;
Parameters
ParameterType
_refreshTokenPathOrObjectunknown
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

ParameterType
app?PyricAdminApp

Returns

Installations


instanceId()

const instanceId: (app?: PyricAdminApp) => InstanceId;

Parameters

ParameterType
app?PyricAdminApp

Returns

InstanceId


machineLearning()

const machineLearning: (app?: PyricAdminApp) => MachineLearning;

Parameters

ParameterType
app?PyricAdminApp

Returns

MachineLearning


messaging()

const messaging: (app?: PyricAdminApp) => Messaging;

Parameters

ParameterType
app?PyricAdminApp

Returns

Messaging


projectManagement()

const projectManagement: (app?: PyricAdminApp) => ProjectManagement;

Parameters

ParameterType
app?PyricAdminApp

Returns

ProjectManagement


remoteConfig()

const remoteConfig: (app?: PyricAdminApp) => RemoteConfig;

Parameters

ParameterType
app?PyricAdminApp

Returns

RemoteConfig


securityRules()

const securityRules: (app?: PyricAdminApp) => SecurityRules;

Parameters

ParameterType
app?PyricAdminApp

Returns

SecurityRules


storage()

const storage: (app?: PyricAdminApp) => Storage;

Parameters

ParameterType
app?PyricAdminApp

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