Interfaces
Database
Properties
Methods
getRules()
getRules(): Promise<string>;
Returns
Promise<string>
getRulesJSON()
getRulesJSON(): Promise<object>;
Returns
Promise<object>
goOffline()
goOffline(): void;
Returns
void
goOnline()
goOnline(): void;
Returns
void
ref()
ref(path?: string): Reference;
Parameters
| Parameter | Type |
|---|---|
path? | string |
Returns
refFromURL()
refFromURL(url: string): Reference;
Parameters
| Parameter | Type |
|---|---|
url | string |
Returns
setRules()
setRules(source: string | object): Promise<void>;
Parameters
| Parameter | Type |
|---|---|
source | string | object |
Returns
Promise<void>
DataSnapshot
Properties
| Property | Modifier | Type |
|---|---|---|
key | readonly | string |
ref | readonly | Reference |
Methods
child()
child(path: string): DataSnapshot;
Parameters
| Parameter | Type |
|---|---|
path | string |
Returns
exists()
exists(): boolean;
Returns
boolean
exportVal()
exportVal(): unknown;
Returns
unknown
forEach()
forEach(action: (child: DataSnapshot) => boolean | void): boolean;
Parameters
| Parameter | Type |
|---|---|
action | (child: DataSnapshot) => boolean | void |
Returns
boolean
getPriority()
getPriority(): string | number;
Returns
string | number
hasChild()
hasChild(path: string): boolean;
Parameters
| Parameter | Type |
|---|---|
path | string |
Returns
boolean
hasChildren()
hasChildren(children?: string[]): boolean;
Parameters
| Parameter | Type |
|---|---|
children? | string[] |
Returns
boolean
numChildren()
numChildren(): number;
Returns
number
toJSON()
toJSON(): unknown;
Returns
unknown
val()
val(): unknown;
Returns
unknown
OnDisconnect
Indexable
[key: string]: unknown
Reference
Indexable
[key: string]: unknown
Properties
| Property | Modifier | Type |
|---|---|---|
database | readonly | Database |
key | readonly | string |
parent | readonly | Reference |
ref | readonly | Reference |
root | readonly | Reference |
Methods
child()
child(path: string): Reference;
Parameters
| Parameter | Type |
|---|---|
path | string |
Returns
get()
get(): Promise<DataSnapshot>;
Returns
Promise<DataSnapshot>
off()
off(
eventType?: EventType,
callback?: (snapshot: DataSnapshot, previousChildKey?: string) => unknown,
context?: object): void;
Parameters
| Parameter | Type |
|---|---|
eventType? | EventType |
callback? | (snapshot: DataSnapshot, previousChildKey?: string) => unknown |
context? | object |
Returns
void
on()
on(
eventType: EventType,
callback: (snapshot: DataSnapshot, previousChildKey?: string) => unknown,
cancelCallbackOrContext?: object | (error: Error) => unknown,
context?: object): unknown;
Parameters
| Parameter | Type |
|---|---|
eventType | EventType |
callback | (snapshot: DataSnapshot, previousChildKey?: string) => unknown |
cancelCallbackOrContext? | object | (error: Error) => unknown |
context? | object |
Returns
unknown
once()
once<T>(
eventType: EventType,
successCallback?: (this: T, snapshot: DataSnapshot, previousChildKey?: string) => unknown,
failureCallbackOrContext?: T | (this: T, error: Error) => unknown,
context?: T): Promise<DataSnapshot>;
Type Parameters
| Type Parameter | Default type |
|---|---|
T | unknown |
Parameters
| Parameter | Type |
|---|---|
eventType | EventType |
successCallback? | (this: T, snapshot: DataSnapshot, previousChildKey?: string) => unknown |
failureCallbackOrContext? | T | (this: T, error: Error) => unknown |
context? | T |
Returns
Promise<DataSnapshot>
push()
push(value?: unknown, onComplete?: (error: Error) => void): ThenableReference;
Parameters
| Parameter | Type |
|---|---|
value? | unknown |
onComplete? | (error: Error) => void |
Returns
remove()
remove(onComplete?: (error: Error) => void): Promise<void>;
Parameters
| Parameter | Type |
|---|---|
onComplete? | (error: Error) => void |
Returns
Promise<void>
set()
set(value: unknown, onComplete?: (error: Error) => void): Promise<void>;
Parameters
| Parameter | Type |
|---|---|
value | unknown |
onComplete? | (error: Error) => void |
Returns
Promise<void>
toJSON()
toJSON(): string;
Returns
string
toString()
toString(): string;
Returns
string
update()
update(values: object, onComplete?: (error: Error) => void): Promise<void>;
Parameters
| Parameter | Type |
|---|---|
values | object |
onComplete? | (error: Error) => void |
Returns
Promise<void>
Type Aliases
EventType
type EventType =
| "value"
| "child_added"
| "child_changed"
| "child_removed"
| "child_moved";
Structural types and callback normalization for the pyric-admin/database
mirror of firebase-admin/database.
Query
type Query = Reference;
ThenableReference
type ThenableReference = Reference & PromiseLike<Reference>;
Variables
enableLogging
const enableLogging: DeferredApi;
firebase-admin/database’s enableLogging (deferred in the sandbox).
ServerValue
const ServerValue: {
increment: (delta: number) => object;
TIMESTAMP: object;
};
Mirror of firebase-admin/database’s ServerValue constant and sentinel constructors.
Type Declaration
increment()
readonly increment: (delta: number) => object;
Parameters
| Parameter | Type |
|---|---|
delta | number |
Returns
object
TIMESTAMP
readonly TIMESTAMP: object;
Functions
getDatabase()
function getDatabase(app?: SandboxAdminApp, url?: string): Database;
Returns the Database service for the supplied app (or the default
app when omitted), optionally scoped to the RTDB instance url names.
Parameters
| Parameter | Type |
|---|---|
app? | SandboxAdminApp |
url? | string |
Returns
getDatabaseWithUrl()
function getDatabaseWithUrl(url: string, app?: SandboxAdminApp): Database;
Returns the Database service for the RTDB instance url names,
matching firebase-admin/database’s getDatabaseWithUrl(url, app?).
Parameters
| Parameter | Type |
|---|---|
url | string |
app? | SandboxAdminApp |