API reference: pyric-admin

Variables

auth()

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

Parameters

Parameter	Type
`app?`	`PyricAdminApp`

Returns

Auth

credential

const credential: {
  applicationDefault: typeof applicationDefault;
  cert: typeof cert;
  refreshToken: (token: string) => {
   [x: symbol]: string;
     token: string;
  };
};

Type Declaration

applicationDefault

applicationDefault: typeof applicationDefault;

cert

cert: typeof cert;

refreshToken()

refreshToken: (token: string) => {
[x: symbol]: string;
  token: string;
};

Parameters

Parameter	Type
`token`	`string`

Returns

{
[x: symbol]: string;
  token: string;
}

token

token: string;

database()

const database: (app?: PyricAdminApp) => Database;

Parameters

Parameter	Type
`app?`	`PyricAdminApp`

Returns

Database

default

const default: {
  ADMIN_APP_TARGET: typeof ADMIN_APP_TARGET;
  auth: (app?: PyricAdminApp) => Auth;
  credential: {
     applicationDefault: typeof applicationDefault;
     cert: typeof cert;
     refreshToken: (token: string) => {
      [x: symbol]: string;
        token: string;
     };
  };
  database: (app?: PyricAdminApp) => Database;
  DEFAULT_APP_NAME: "[DEFAULT]";
  firestore: (app?: PyricAdminApp) => SandboxFirestore;
  messaging: (app?: PyricAdminApp) => Messaging;
  storage: (app?: PyricAdminApp) => Storage;
  applicationDefault: never;
  cert: object;
  deleteApp: Promise<void>;
  getApp: SandboxAdminApp;
  getApps: SandboxAdminApp[];
  initializeApp: SandboxAdminApp;
  isSandboxAdminApp: app is SandboxAdminApp;
};

Type Declaration

ADMIN_APP_TARGET

ADMIN_APP_TARGET: typeof ADMIN_APP_TARGET;

auth()

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

Parameters

Parameter	Type
`app?`	`PyricAdminApp`

Returns

Auth

credential

credential: {
  applicationDefault: typeof applicationDefault;
  cert: typeof cert;
  refreshToken: (token: string) => {
   [x: symbol]: string;
     token: string;
  };
};

credential.applicationDefault

applicationDefault: typeof applicationDefault;

credential.cert

cert: typeof cert;

credential.refreshToken()

refreshToken: (token: string) => {
[x: symbol]: string;
  token: string;
};

Parameters

Parameter	Type
`token`	`string`

Returns

{
[x: symbol]: string;
  token: string;
}

token

token: string;

database()

database: (app?: PyricAdminApp) => Database;

Parameters

Parameter	Type
`app?`	`PyricAdminApp`

Returns

Database

DEFAULT_APP_NAME

DEFAULT_APP_NAME: "[DEFAULT]";

firestore()

firestore: (app?: PyricAdminApp) => SandboxFirestore;

Parameters

Parameter	Type
`app?`	`PyricAdminApp`

Returns

SandboxFirestore

messaging()

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

Parameters

Parameter	Type
`app?`	`PyricAdminApp`

Returns

Messaging

storage()

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

Parameters

Parameter	Type
`app?`	`PyricAdminApp`

Returns

Storage

applicationDefault()

applicationDefault(): never;

Returns

never

cert()

cert(serviceAccountPathOrObject: unknown): object;

Parameters

Parameter	Type
`serviceAccountPathOrObject`	`unknown`

Returns

object

deleteApp()

deleteApp(app: SandboxAdminApp): Promise<void>;

Parameters

Parameter	Type
`app`	`SandboxAdminApp`

Returns

Promise<void>

getApp()

getApp(name?: string): SandboxAdminApp;

Parameters

Parameter	Type
`name?`	`string`

Returns

SandboxAdminApp

getApps()

getApps(): SandboxAdminApp[];

Returns

SandboxAdminApp[]

initializeApp()

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

Parameters

Parameter	Type
`config?`	\| `Record`<`string`, `unknown`> \| `InitializeAdminAppConfig`
`name?`	`string`

Returns

SandboxAdminApp

isSandboxAdminApp()

isSandboxAdminApp(app: SandboxAdminApp): app is SandboxAdminApp;

Parameters

Parameter	Type
`app`	`SandboxAdminApp`

Returns

app is SandboxAdminApp

firestore()

const firestore: (app?: PyricAdminApp) => SandboxFirestore;

Parameters

Parameter	Type
`app?`	`PyricAdminApp`

Returns

SandboxFirestore

messaging()

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

Parameters

Parameter	Type
`app?`	`PyricAdminApp`

Returns

Messaging

storage()

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

Parameters

Parameter	Type
`app?`	`PyricAdminApp`

Returns

Storage

References

ADMIN_APP_TARGET

Re-exports ADMIN_APP_TARGET

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