Skip to content

Commit 925409c

Browse files
schmidt-sebastianschmidt-sebastian
committed
Add API Review file
1 parent e3b6c93 commit 925409c

File tree

1 file changed

+241
-0
lines changed

1 file changed

+241
-0
lines changed

‎common/api-review/database-exp.api.md

Lines changed: 241 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,241 @@
1+
## API Report File for "@firebase/database-exp"
2+
3+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4+
5+
```ts
6+
7+
import { FirebaseApp } from '@firebase/app';
8+
9+
// @public (undocumented)
10+
export class DataSnapshot {
11+
child(path: string): DataSnapshot;
12+
exists(): boolean;
13+
exportVal(): any;
14+
forEach(action: (child: DataSnapshot) => boolean | void): boolean;
15+
hasChild(path: string): boolean;
16+
hasChildren(): boolean;
17+
get key(): string | null;
18+
get priority(): string | number | null;
19+
// (undocumented)
20+
readonly ref: Reference;
21+
get size(): number;
22+
toJSON(): object | null;
23+
val(): any;
24+
}
25+
26+
// @public
27+
export function enableLogging(enabled: boolean, persistent?: boolean): any;
28+
29+
// @public
30+
export function enableLogging(logger?: (message: string) => unknown, persistent?: boolean): any;
31+
32+
// @public
33+
export function endAt(value: number | string | boolean | null, key?: string): QueryConstraint;
34+
35+
// @public
36+
export function endBefore(value: number | string | boolean | null, key?: string): QueryConstraint;
37+
38+
// @public
39+
export function equalTo(value: number | string | boolean | null, key?: string): QueryConstraint;
40+
41+
// @public
42+
export type EventType = 'value' | 'child_added' | 'child_changed' | 'child_moved' | 'child_removed';
43+
44+
// @public
45+
export class FirebaseDatabase {
46+
// (undocumented)
47+
readonly app: FirebaseApp;
48+
// (undocumented)
49+
readonly 'type' = "database";
50+
}
51+
52+
// @public
53+
export function get(query: Query): Promise<DataSnapshot>;
54+
55+
// @public
56+
export function getDatabase(app: FirebaseApp, url?: string): FirebaseDatabase;
57+
58+
// @public
59+
export function goOffline(db: FirebaseDatabase): void;
60+
61+
// @public
62+
export function goOnline(db: FirebaseDatabase): void;
63+
64+
// @public
65+
export function increment(delta: number): object;
66+
67+
// @public
68+
export function limitToFirst(limit: number): QueryConstraint;
69+
70+
// @public
71+
export function limitToLast(limit: number): QueryConstraint;
72+
73+
// @public
74+
export interface ListenOptions {
75+
readonly onlyOnce?: boolean;
76+
}
77+
78+
// @public
79+
export function off(query: Query, eventType?: EventType, callback?: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown): void;
80+
81+
// @public
82+
export function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
83+
84+
// @public
85+
export function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;
86+
87+
// @public
88+
export function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
89+
90+
// @public
91+
export function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
92+
93+
// @public
94+
export function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;
95+
96+
// @public
97+
export function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
98+
99+
// @public
100+
export function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
101+
102+
// @public
103+
export function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;
104+
105+
// @public
106+
export function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
107+
108+
// @public
109+
export function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
110+
111+
// @public
112+
export function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;
113+
114+
// @public
115+
export function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
116+
117+
// @public
118+
export class OnDisconnect {
119+
cancel(): Promise<void>;
120+
remove(): Promise<void>;
121+
set(value: unknown): Promise<void>;
122+
setWithPriority(value: unknown, priority: number | string | null): Promise<void>;
123+
update(values: object): Promise<void>;
124+
}
125+
126+
// @public
127+
export function onDisconnect(ref: Reference): OnDisconnect;
128+
129+
// @public
130+
export function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
131+
132+
// @public
133+
export function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;
134+
135+
// @public
136+
export function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
137+
138+
// @public
139+
export function orderByChild(path: string): QueryConstraint;
140+
141+
// @public
142+
export function orderByKey(): QueryConstraint;
143+
144+
// @public
145+
export function orderByPriority(): QueryConstraint;
146+
147+
// @public
148+
export function orderByValue(): QueryConstraint;
149+
150+
// @public
151+
export function push(parent: Reference, value?: unknown): ThenableReference;
152+
153+
// @public
154+
export interface Query {
155+
isEqual(other: Query | null): boolean;
156+
readonly ref: Reference;
157+
toJSON(): string;
158+
toString(): string;
159+
}
160+
161+
// @public
162+
export function query(query: Query, ...queryConstraints: QueryConstraint[]): Query;
163+
164+
// @public
165+
export abstract class QueryConstraint {
166+
abstract readonly type: QueryConstraintType;
167+
}
168+
169+
// @public
170+
export type QueryConstraintType = 'endAt' | 'endBefore' | 'startAt' | 'startAfter' | 'limitToFirst' | 'limitToLast' | 'orderByChild' | 'orderByKey' | 'orderByPriority' | 'orderByValue' | 'equalTo';
171+
172+
// @public
173+
export function ref(db: FirebaseDatabase, path?: string): Reference;
174+
175+
// @public
176+
export interface Reference extends Query {
177+
readonly key: string | null;
178+
readonly parent: Reference | null;
179+
readonly root: Reference;
180+
}
181+
182+
// @public
183+
export function refFromURL(db: FirebaseDatabase, url: string): Reference;
184+
185+
// @public
186+
export function remove(ref: Reference): Promise<void>;
187+
188+
// @public
189+
export function runTransaction(ref: Reference, transactionUpdate: (currentData: any) => unknown, options?: TransactionOptions): Promise<TransactionResult>;
190+
191+
// @public
192+
export function serverTimestamp(): object;
193+
194+
// @public
195+
export function set(ref: Reference, value: unknown): Promise<void>;
196+
197+
// @public
198+
export function setPriority(ref: Reference, priority: string | number | null): Promise<void>;
199+
200+
// @public
201+
export function setWithPriority(ref: Reference, value: unknown, priority: string | number | null): Promise<void>;
202+
203+
// @public
204+
export function startAfter(value: number | string | boolean | null, key?: string): QueryConstraint;
205+
206+
// @public
207+
export function startAt(value?: number | string | boolean | null, key?: string): QueryConstraint;
208+
209+
// @public
210+
export interface ThenableReference extends Reference, Pick<Promise<Reference>, 'then' | 'catch'> {
211+
}
212+
213+
// @public
214+
export interface TransactionOptions {
215+
readonly applyLocally?: boolean;
216+
}
217+
218+
// @public (undocumented)
219+
export class TransactionResult {
220+
constructor(committed: boolean, snapshot: DataSnapshot);
221+
// (undocumented)
222+
readonly committed: boolean;
223+
// (undocumented)
224+
readonly snapshot: DataSnapshot;
225+
// (undocumented)
226+
toJSON(): object;
227+
}
228+
229+
// @public
230+
export type Unsubscribe = () => void;
231+
232+
// @public
233+
export function update(ref: Reference, values: object): Promise<void>;
234+
235+
// @public
236+
export function useDatabaseEmulator(db: FirebaseDatabase, host: string, port: number): void;
237+
238+
239+
// (No @packageDocumentation comment for this package)
240+
241+
```

0 commit comments

Comments
 (0)