Reference | JavaScript SDK  |  Firebase JavaScript API reference (original) (raw)

Index

Properties

key

key: string | null

parent

ref

root

Methods

child

• child( path : string ) : Reference

• Parameters

  • path: string

Returns Reference

The specified child location.

endAt

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

• Parameters

  • value: number | string | boolean | null

  • Optional key: string

Returns Query

endBefore

• endBefore( value : number | string | boolean | null , key ? : string ) : Query

• Parameters

  • value: number | string | boolean | null

  • Optional key: string

Returns Query

equalTo

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

• Parameters

  • value: number | string | boolean | null

  • Optional key: string

Returns Query

get

• get( ) : Promise < DataSnapshot >

• Returns Promise<DataSnapshot>

A promise which resolves to the resulting DataSnapshot if a value is available, or rejects if the client is unable to return a value (e.g., if the server is unreachable and there is nothing cached).

isEqual

• isEqual( other : Query | null ) : boolean

• Parameters

  • other: Query | null

Returns boolean

Whether or not the current and provided queries are equivalent.

limitToFirst

• limitToFirst( limit : number ) : Query

• Parameters

  • limit: number

Returns Query

limitToLast

• limitToLast( limit : number ) : Query

• Parameters

  • limit: number

Returns Query

off

• off( eventType ? : EventType , callback ? : ( a : DataSnapshot , b ? : string | null ) => any , context ? : Object | null ) : void

• Parameters

  • Optional eventType: EventType

  • Optional callback: (a: DataSnapshot, b?: string | null) => any

    * * (a: [DataSnapshot](/docs/reference/js/v8/firebase.database.DataSnapshot), b?: string | null): any  
             * #### Parameters  
                         * ##### a: [DataSnapshot](/docs/reference/js/v8/firebase.database.DataSnapshot)  
                         * ##### Optional b: string | null  
             #### Returns any  

  • Optional context: Object | null

Returns void

on

• on( eventType : EventType , callback : ( a : DataSnapshot , b ? : string | null ) => any , cancelCallbackOrContext ? : ( ( a : Error ) => any ) | Object | null , context ? : Object | null ) : ( a : DataSnapshot | null , b ? : string | null ) => any

• Parameters

  • eventType: EventType

  • callback: (a: DataSnapshot, b?: string | null) => any

    * * (a: [DataSnapshot](/docs/reference/js/v8/firebase.database.DataSnapshot), b?: string | null): any  
             * #### Parameters  
                         * ##### a: [DataSnapshot](/docs/reference/js/v8/firebase.database.DataSnapshot)  
                         * ##### Optional b: string | null  
             #### Returns any  

  • Optional cancelCallbackOrContext: ((a: Error) => any) | Object | null

  • Optional context: Object | null

Returns (a: DataSnapshot | null, b?: string | null) => any

The provided callback function is returned unmodified. This is just for convenience if you want to pass an inline function to on() but store the callback function for later passing to off().

• • (a: DataSnapshot | null, b?: string | null): any

    • Parameters

         * ##### a: [DataSnapshot](/docs/reference/js/v8/firebase.database.DataSnapshot) | null  
         * ##### Optional b: string | null

    Returns any

onDisconnect

• onDisconnect( ) : OnDisconnect

• Returns OnDisconnect

once

• once( eventType : EventType , successCallback ? : ( a : DataSnapshot , b ? : string | null ) => any , failureCallbackOrContext ? : ( ( a : Error ) => void ) | Object | null , context ? : Object | null ) : Promise < DataSnapshot >

• Parameters

  • eventType: EventType

  • Optional successCallback: (a: DataSnapshot, b?: string | null) => any

    * * (a: [DataSnapshot](/docs/reference/js/v8/firebase.database.DataSnapshot), b?: string | null): any  
             * #### Parameters  
                         * ##### a: [DataSnapshot](/docs/reference/js/v8/firebase.database.DataSnapshot)  
                         * ##### Optional b: string | null  
             #### Returns any  

  • Optional failureCallbackOrContext: ((a: Error) => void) | Object | null

  • Optional context: Object | null

Returns Promise<DataSnapshot>

orderByChild

• orderByChild( path : string ) : Query

• Parameters

  • path: string

Returns Query

orderByKey

• orderByKey( ) : Query

• Returns Query

orderByPriority

• orderByPriority( ) : Query

• Returns Query

orderByValue

• orderByValue( ) : Query

• Returns Query

push

• push( value ? : any , onComplete ? : ( a : Error | null ) => any ) : ThenableReference

• Parameters

  • Optional value: any

  • Optional onComplete: (a: Error | null) => any

    * * (a: [Error](/docs/reference/js/v8/firebase.functions.HttpsError#error) | null): any  
             * #### Parameters  
                         * ##### a: [Error](/docs/reference/js/v8/firebase.functions.HttpsError#error) | null  
             #### Returns any

Returns ThenableReference

Combined Promise and Reference; resolves when write is complete, but can be used immediately as the Reference to the child location.

remove

• remove( onComplete ? : ( a : Error | null ) => void ) : Promise < void >

• Parameters

  • Optional onComplete: (a: Error | null) => void

    * * (a: [Error](/docs/reference/js/v8/firebase.functions.HttpsError#error) | null): void  
             * #### Parameters  
                         * ##### a: [Error](/docs/reference/js/v8/firebase.functions.HttpsError#error) | null  
             #### Returns void

Returns Promise<void>

Resolves when remove on server is complete.

set

• set( value : any , onComplete ? : ( a : Error | null ) => void ) : Promise < void >

• Parameters

  • value: any

  • Optional onComplete: (a: Error | null) => void

    * * (a: [Error](/docs/reference/js/v8/firebase.functions.HttpsError#error) | null): void  
             * #### Parameters  
                         * ##### a: [Error](/docs/reference/js/v8/firebase.functions.HttpsError#error) | null  
             #### Returns void

Returns Promise<void>

Resolves when write to server is complete.

setPriority

• setPriority( priority : string | number | null , onComplete : ( a : Error | null ) => void ) : Promise < void >

• Parameters

  • priority: string | number | null

  • onComplete: (a: Error | null) => void

    * * (a: [Error](/docs/reference/js/v8/firebase.functions.HttpsError#error) | null): void  
             * #### Parameters  
                         * ##### a: [Error](/docs/reference/js/v8/firebase.functions.HttpsError#error) | null  
             #### Returns void

Returns Promise<void>

setWithPriority

• setWithPriority( newVal : any , newPriority : string | number | null , onComplete ? : ( a : Error | null ) => void ) : Promise < void >

• Parameters

  • newVal: any

  • newPriority: string | number | null

  • Optional onComplete: (a: Error | null) => void

    * * (a: [Error](/docs/reference/js/v8/firebase.functions.HttpsError#error) | null): void  
             * #### Parameters  
                         * ##### a: [Error](/docs/reference/js/v8/firebase.functions.HttpsError#error) | null  
             #### Returns void

Returns Promise<void>

startAfter

• startAfter( value : number | string | boolean | null , key ? : string ) : Query

• Parameters

  • value: number | string | boolean | null

  • Optional key: string

Returns Query

startAt

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

• Parameters

  • value: number | string | boolean | null

  • Optional key: string

Returns Query

toJSON

• toJSON( ) : Object

• Returns Object

A JSON-serializable representation of this object.

toString

• toString( ) : string

• Returns string

The absolute URL for this location.

transaction

• transaction( transactionUpdate : ( a : any ) => any , onComplete ? : ( a : Error | null , b : boolean , c : DataSnapshot | null ) => void , applyLocally ? : boolean ) : Promise < TransactionResult >

• Parameters

  • transactionUpdate: (a: any) => any

    * * (a: any): any  
             * #### Parameters  
                         * ##### a: any  
             #### Returns any  

  • Optional onComplete: (a: Error | null, b: boolean, c: DataSnapshot | null) => void

    * * (a: [Error](/docs/reference/js/v8/firebase.functions.HttpsError#error) | null, b: boolean, c: [DataSnapshot](/docs/reference/js/v8/firebase.database.DataSnapshot) | null): void  
             * #### Parameters  
                         * ##### a: [Error](/docs/reference/js/v8/firebase.functions.HttpsError#error) | null  
                         * ##### b: boolean  
                         * ##### c: [DataSnapshot](/docs/reference/js/v8/firebase.database.DataSnapshot) | null  
             #### Returns void  

  • Optional applyLocally: boolean

Returns Promise<TransactionResult>

Returns a Promise that can optionally be used instead of the onComplete callback to handle success and failure.

update

• update( values : Object , onComplete ? : ( a : Error | null ) => void ) : Promise < void >

• Parameters

  • values: Object

  • Optional onComplete: (a: Error | null) => void

    * * (a: [Error](/docs/reference/js/v8/firebase.functions.HttpsError#error) | null): void  
             * #### Parameters  
                         * ##### a: [Error](/docs/reference/js/v8/firebase.functions.HttpsError#error) | null  
             #### Returns void

Returns Promise<void>

Resolves when update on server is complete.