API reference: pyric/app

Classes

FirebaseError

Firebase-shaped error primitive shared by the sandbox client mirrors.

It lives below every service surface so mirrors can preserve cross-service instanceof FirebaseError identity without depending on the app composition root or loading the production SDK.

Extends

Error

Extended by

AIError

Constructors

Constructor

new FirebaseError(
   code: string,
   message: string,
   customData?: Record<string, unknown>): FirebaseError;

Parameters

Parameter	Type
`code`	`string`
`message`	`string`
`customData?`	`Record`<`string`, `unknown`>

Returns

FirebaseError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Default value	Overrides
`code`	`readonly`	`string`	`undefined`	-
`customData?`	`readonly`	`Record`<`string`, `unknown`>	`undefined`	-
`name`	`readonly`	`"FirebaseError"`	`"FirebaseError"`	`Error.name`

Interfaces

FirebaseApp

Properties

Property	Modifier	Type
`automaticDataCollectionEnabled`	`public`	`boolean`
`name`	`readonly`	`string`
`options`	`readonly`	`FirebaseOptions`

FirebaseAppSettings

Properties

Property	Type
`automaticDataCollectionEnabled?`	`boolean`
`name?`	`string`

FirebaseOptions

Firebase-compatible public value types for pyric/app.

Properties

Property	Type
`apiKey?`	`string`
`appId?`	`string`
`authDomain?`	`string`
`databaseURL?`	`string`
`measurementId?`	`string`
`messagingSenderId?`	`string`
`projectId?`	`string`
`storageBucket?`	`string`

LogEntry

Properties

Property	Type
`args`	`unknown`[]
`level`	`LogLevel`
`message`	`string`
`type`	`string`

LogOptions

Properties

Property	Type
`level`	`LogLevel`

Type Aliases

LogCallback()

type LogCallback = (entry: LogEntry) => void;

Parameters

Parameter	Type
`entry`	`LogEntry`

Returns

void

LogLevel

type LogLevel = "debug" | "verbose" | "info" | "warn" | "error" | "silent";

Variables

SDK_VERSION

const SDK_VERSION: "12.13.0" = "12.13.0";

Firebase JS SDK version whose public app behavior the current oracle records. The app conformance replay makes this pin fail visibly when observations move.

Functions

deleteApp()

function deleteApp(app: FirebaseApp): Promise<void>;

Parameters

Parameter	Type
`app`	`FirebaseApp`

Returns

Promise<void>

getApp()

function getApp(name?: string): FirebaseApp;

Parameters

Parameter	Type
`name?`	`string`

Returns

FirebaseApp

getApps()

function getApps(): FirebaseApp[];

Returns

FirebaseApp[]

initializeApp()

function initializeApp(options?: FirebaseOptions, rawSettings?: string | FirebaseAppSettings): FirebaseApp;

Parameters

Parameter	Type
`options?`	`FirebaseOptions`
`rawSettings?`	`string` \| `FirebaseAppSettings`

Returns

FirebaseApp

onLog()

function onLog(callback: LogCallback, options?: LogOptions): void;

Parameters

Parameter	Type
`callback`	`LogCallback`
`options?`	`LogOptions`

Returns

void

registerVersion()

function registerVersion(
   libraryKeyOrName: string,
   version: string,
   variant?: string): void;

Validate a platform-logger version registration.

A sandbox has no production component container, so valid registrations need no retained component. Invalid registrations still emit the exact diagnostic warning consumers can observe from Firebase.

Parameters

Parameter	Type
`libraryKeyOrName`	`string`
`version`	`string`
`variant?`	`string`

Returns

void

setLogLevel()

function setLogLevel(level: LogLevel): void;

Set the threshold used by the app diagnostics logger.

Parameters

Parameter	Type
`level`	`LogLevel`

Returns

void