Reference

The last part of the Reference's path. For example, "ada" is the key for https://<DATABASE_NAME>.firebaseio.com/users/ada. The key of a root Reference is null.

key: string | null;

The parent location of a Reference. The parent of a root Reference is null.

parent: Reference | null;

Returns a Reference to the Query's location.

ref: Reference;

The root Reference of the Database.

root: Reference;

Gets a Reference for the location at the specified relative path.

child(path: string): Reference;

Creates a Query with the specified ending point.

endAt(value: number | string | boolean | null, key?: undefined | string): Query;

Creates a Query with the specified ending point.

equalTo(value: number | string | boolean | null, key?: undefined | string): Query;

Returns whether or not the current and provided queries represent the same location, have the same query parameters.

isEqual(other: Query): boolean;

By calling keepSynced(true) on a location, the data for that location will automatically be downloaded and kept in sync, even when no listeners are attached for that location.

keepSynced(bool: boolean): Promise<void>;

Generates a new Query limited to the first specific number of children.

limitToFirst(limit: number): Query;

Generates a new Query object limited to the last specific number of children.

limitToLast(limit: number): Query;

Detaches a callback previously attached with on().

off(eventType?: EventType, callback?: Function, context?: Record<string, any>): void;

Listens for data changes at a particular location.

on(eventType?: EventType, callback?: Function, cancelCallbackOrContext?: Record<string, any>, context?: Record<string, any> | null): Function;

Returns an OnDisconnect instance.

onDisconnect(): OnDisconnect;

Listens for exactly one event of the specified event type, and then stops listening.

once(eventType: EventType, successCallback?: undefined | (a: DataSnapshot, b: string | null) => any, failureCallbackContext?: (a: Error) => void | Record<string, any> | null): Promise<DataSnapshot>;

Generates a new Query object ordered by the specified child key.

orderByChild(path: string): Query;

Generates a new Query object ordered by key.

orderByKey(): Query;

Generates a new Query object ordered by priority.

orderByPriority(): Query;

Generates a new Query object ordered by value.

orderByValue(): Query;

Generates a new child location using a unique key and returns its Reference.

push(value?: any, onComplete?: Function): ThenableReference;

Removes the data at this Database location.

remove(onComplete?: Function): Promise<void>;

Writes data to this Database location.

set(value: any, onComplete?: Function): Promise<void>;

Sets a priority for the data at this Database location. Setting null removes any priority at this location.

setPriority(priority: string | number | null, onComplete?: Function): Promise<void>;

Writes data the Database location. Like set() but also specifies the priority for that data.

setWithPriority(newVal: any, newPriority: string | number | null, onComplete?: Function): Promise<void>;

Creates a Query with the specified starting point.

startAt(value: number | string | boolean | null, key?: undefined | string): Query;

Returns a JSON-serializable representation of this object.

toJSON(): object;

Gets the absolute URL for this location.

toString(): string;

Atomically modifies the data at this location.

transaction(transactionUpdate: Function, onComplete?: Function, applyLocally?: undefined | false | true): Promise<TransactionResult>;

Writes multiple values to the Database at once.

update(values: { [key: string]: value }, onComplete?: Function): Promise<void>;