Skip to content

Latest commit

 

History

History
256 lines (186 loc) · 8.27 KB

database.api.md

File metadata and controls

256 lines (186 loc) · 8.27 KB

API Report File for "@firebase/database"

Do not edit this file. It is a report generated by API Extractor.

import{EmulatorMockTokenOptions}from'@firebase/util';import{FirebaseApp}from'@firebase/app';// @publicexportfunctionchild(parent: DatabaseReference,path: string): DatabaseReference;// @publicexportfunctionconnectDatabaseEmulator(db: Database,host: string,port: number,options?: {mockUserToken?: EmulatorMockTokenOptions|string;}): void;// @publicexportclassDatabase{readonlyapp: FirebaseApp;readonly'type'="database";}// @publicexportinterfaceDatabaseReferenceextendsQuery{readonlykey: string|null;readonlyparent: DatabaseReference|null;readonlyroot: DatabaseReference;}// @publicexportclassDataSnapshot{child(path: string): DataSnapshot;exists(): boolean;exportVal(): any;forEach(action: (child: IteratedDataSnapshot)=>boolean|void): boolean;hasChild(path: string): boolean;hasChildren(): boolean;getkey(): string|null;getpriority(): string|number|null;readonlyref: DatabaseReference;getsize(): number;toJSON(): object|null;val(): any;}export{EmulatorMockTokenOptions}// @publicexportfunctionenableLogging(enabled: boolean,persistent?: boolean): any;// @publicexportfunctionenableLogging(logger: (message: string)=>unknown): any;// @publicexportfunctionendAt(value: number|string|boolean|null,key?: string): QueryConstraint;// @publicexportfunctionendBefore(value: number|string|boolean|null,key?: string): QueryConstraint;// @publicexportfunctionequalTo(value: number|string|boolean|null,key?: string): QueryConstraint;// @publicexporttypeEventType='value'|'child_added'|'child_changed'|'child_moved'|'child_removed';// @publicexportfunctionforceLongPolling(): void;// @publicexportfunctionforceWebSockets(): void;// @publicexportfunctionget(query: Query): Promise<DataSnapshot>;// @publicexportfunctiongetDatabase(app?: FirebaseApp,url?: string): Database;// @publicexportfunctiongoOffline(db: Database): void;// @publicexportfunctiongoOnline(db: Database): void;// @publicexportfunctionincrement(delta: number): object;// @publicexportinterfaceIteratedDataSnapshotextendsDataSnapshot{// (undocumented)key: string;}// @publicexportfunctionlimitToFirst(limit: number): QueryConstraint;// @publicexportfunctionlimitToLast(limit: number): QueryConstraint;// @publicexportinterfaceListenOptions{readonlyonlyOnce?: boolean;}// @publicexportfunctionoff(query: Query,eventType?: EventType,callback?: (snapshot: DataSnapshot,previousChildName?: string|null)=>unknown): void;// @publicexportfunctiononChildAdded(query: Query,callback: (snapshot: DataSnapshot,previousChildName?: string|null)=>unknown,cancelCallback?: (error: Error)=>unknown): Unsubscribe;// @publicexportfunctiononChildAdded(query: Query,callback: (snapshot: DataSnapshot,previousChildName: string|null)=>unknown,options: ListenOptions): Unsubscribe;// @publicexportfunctiononChildAdded(query: Query,callback: (snapshot: DataSnapshot,previousChildName: string|null)=>unknown,cancelCallback: (error: Error)=>unknown,options: ListenOptions): Unsubscribe;// @publicexportfunctiononChildChanged(query: Query,callback: (snapshot: DataSnapshot,previousChildName: string|null)=>unknown,cancelCallback?: (error: Error)=>unknown): Unsubscribe;// @publicexportfunctiononChildChanged(query: Query,callback: (snapshot: DataSnapshot,previousChildName: string|null)=>unknown,options: ListenOptions): Unsubscribe;// @publicexportfunctiononChildChanged(query: Query,callback: (snapshot: DataSnapshot,previousChildName: string|null)=>unknown,cancelCallback: (error: Error)=>unknown,options: ListenOptions): Unsubscribe;// @publicexportfunctiononChildMoved(query: Query,callback: (snapshot: DataSnapshot,previousChildName: string|null)=>unknown,cancelCallback?: (error: Error)=>unknown): Unsubscribe;// @publicexportfunctiononChildMoved(query: Query,callback: (snapshot: DataSnapshot,previousChildName: string|null)=>unknown,options: ListenOptions): Unsubscribe;// @publicexportfunctiononChildMoved(query: Query,callback: (snapshot: DataSnapshot,previousChildName: string|null)=>unknown,cancelCallback: (error: Error)=>unknown,options: ListenOptions): Unsubscribe;// @publicexportfunctiononChildRemoved(query: Query,callback: (snapshot: DataSnapshot)=>unknown,cancelCallback?: (error: Error)=>unknown): Unsubscribe;// @publicexportfunctiononChildRemoved(query: Query,callback: (snapshot: DataSnapshot)=>unknown,options: ListenOptions): Unsubscribe;// @publicexportfunctiononChildRemoved(query: Query,callback: (snapshot: DataSnapshot)=>unknown,cancelCallback: (error: Error)=>unknown,options: ListenOptions): Unsubscribe;// @publicexportclassOnDisconnect{cancel(): Promise<void>;remove(): Promise<void>;set(value: unknown): Promise<void>;setWithPriority(value: unknown,priority: number|string|null): Promise<void>;update(values: object): Promise<void>;}// @publicexportfunctiononDisconnect(ref: DatabaseReference): OnDisconnect;// @publicexportfunctiononValue(query: Query,callback: (snapshot: DataSnapshot)=>unknown,cancelCallback?: (error: Error)=>unknown): Unsubscribe;// @publicexportfunctiononValue(query: Query,callback: (snapshot: DataSnapshot)=>unknown,options: ListenOptions): Unsubscribe;// @publicexportfunctiononValue(query: Query,callback: (snapshot: DataSnapshot)=>unknown,cancelCallback: (error: Error)=>unknown,options: ListenOptions): Unsubscribe;// @publicexportfunctionorderByChild(path: string): QueryConstraint;// @publicexportfunctionorderByKey(): QueryConstraint;// @publicexportfunctionorderByPriority(): QueryConstraint;// @publicexportfunctionorderByValue(): QueryConstraint;// @publicexportfunctionpush(parent: DatabaseReference,value?: unknown): ThenableReference;// @publicexportinterfaceQuery{isEqual(other: Query|null): boolean;readonlyref: DatabaseReference;toJSON(): string;toString(): string;}// @publicexportfunctionquery(query: Query, ...queryConstraints: QueryConstraint[]): Query;// @publicexportabstractclassQueryConstraint{abstractreadonlytype: QueryConstraintType;}// @publicexporttypeQueryConstraintType='endAt'|'endBefore'|'startAt'|'startAfter'|'limitToFirst'|'limitToLast'|'orderByChild'|'orderByKey'|'orderByPriority'|'orderByValue'|'equalTo';// @publicexportfunctionref(db: Database,path?: string): DatabaseReference;// @publicexportfunctionrefFromURL(db: Database,url: string): DatabaseReference;// @publicexportfunctionremove(ref: DatabaseReference): Promise<void>;// @publicexportfunctionrunTransaction(ref: DatabaseReference,transactionUpdate: (currentData: any)=>unknown,options?: TransactionOptions): Promise<TransactionResult>;// @publicexportfunctionserverTimestamp(): object;// @publicexportfunctionset(ref: DatabaseReference,value: unknown): Promise<void>;// @publicexportfunctionsetPriority(ref: DatabaseReference,priority: string|number|null): Promise<void>;// @publicexportfunctionsetWithPriority(ref: DatabaseReference,value: unknown,priority: string|number|null): Promise<void>;// @publicexportfunctionstartAfter(value: number|string|boolean|null,key?: string): QueryConstraint;// @publicexportfunctionstartAt(value?: number|string|boolean|null,key?: string): QueryConstraint;// @publicexportinterfaceThenableReferenceextendsDatabaseReference,Pick<Promise<DatabaseReference>,'then'|'catch'>{// (undocumented)key: string;// (undocumented)parent: DatabaseReference;}// @publicexportinterfaceTransactionOptions{readonlyapplyLocally?: boolean;}// @publicexportclassTransactionResult{readonlycommitted: boolean;readonlysnapshot: DataSnapshot;toJSON(): object;}// @publicexporttypeUnsubscribe=()=>void;// @publicexportfunctionupdate(ref: DatabaseReference,values: object): Promise<void>;
close