Navigate

API reference

pyric-admin/database

11 published symbols from pyric-admin

Generated from the TypeScript declarations shipped at this import path.

Interfaces

Database

Properties

PropertyModifierType
appreadonlyunknown

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

Reference

refFromURL()
refFromURL(url: string): Reference;
Parameters
ParameterType
urlstring
Returns

Reference

setRules()
setRules(source: string | object): Promise<void>;
Parameters
ParameterType
sourcestring | object
Returns

Promise<void>


DataSnapshot

Properties

PropertyModifierType
keyreadonlystring
refreadonlyReference

Methods

child()
child(path: string): DataSnapshot;
Parameters
ParameterType
pathstring
Returns

DataSnapshot

exists()
exists(): boolean;
Returns

boolean

exportVal()
exportVal(): unknown;
Returns

unknown

forEach()
forEach(action: (child: DataSnapshot) => boolean | void): boolean;
Parameters
ParameterType
action(child: DataSnapshot) => boolean | void
Returns

boolean

getPriority()
getPriority(): string | number;
Returns

string | number

hasChild()
hasChild(path: string): boolean;
Parameters
ParameterType
pathstring
Returns

boolean

hasChildren()
hasChildren(children?: string[]): boolean;
Parameters
ParameterType
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

PropertyModifierType
databasereadonlyDatabase
keyreadonlystring
parentreadonlyReference
refreadonlyReference
rootreadonlyReference

Methods

child()
child(path: string): Reference;
Parameters
ParameterType
pathstring
Returns

Reference

get()
get(): Promise<DataSnapshot>;
Returns

Promise<DataSnapshot>

off()
off(
   eventType?: EventType,
   callback?: (snapshot: DataSnapshot, previousChildKey?: string) => unknown,
   context?: object): void;
Parameters
ParameterType
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
ParameterType
eventTypeEventType
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 ParameterDefault type
Tunknown
Parameters
ParameterType
eventTypeEventType
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
ParameterType
value?unknown
onComplete?(error: Error) => void
Returns

ThenableReference

remove()
remove(onComplete?: (error: Error) => void): Promise<void>;
Parameters
ParameterType
onComplete?(error: Error) => void
Returns

Promise<void>

set()
set(value: unknown, onComplete?: (error: Error) => void): Promise<void>;
Parameters
ParameterType
valueunknown
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
ParameterType
valuesobject
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
ParameterType
deltanumber
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

ParameterType
app?SandboxAdminApp
url?string

Returns

Database


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

ParameterType
urlstring
app?SandboxAdminApp

Returns

Database