Skip to content

Commit e2d1a40

Browse files
jshcrowthejshcrowthe
committed
docs(*): automatic .d.ts update from externs
1 parent dc0c9e4 commit e2d1a40

File tree

2 files changed

+54
-40
lines changed

2 files changed

+54
-40
lines changed

‎typings/app.d.ts

+27-20
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,21 @@
1414
* limitations under the License.
1515
*/
1616
declare namespace firebase {
17+
type CompleteFn = ( ) => undefined ;
18+
1719
interface FirebaseError {
1820
code : string ;
1921
message : string ;
2022
name : string ;
2123
stack ? : string ;
2224
}
2325

26+
interface Observer < V , E > {
27+
complete ( ) : any ;
28+
error (error : E ) : any ;
29+
next (value : V | null ) : any ;
30+
}
31+
2432
class Promise < T > extends Promise_Instance < T > {
2533
static all (values : firebase.Promise < any > [] ) : firebase.Promise < any [] > ;
2634
static reject (error : Error ) : firebase.Promise < any > ;
@@ -39,6 +47,8 @@ declare namespace firebase {
3947
then (onResolve ? : (a : T ) => any , onReject ? : (a : Error ) => any ) : firebase.Thenable < any > ;
4048
}
4149

50+
type Unsubscribe = ( ) => undefined ;
51+
4252
interface User extends firebase.UserInfo {
4353
delete ( ) : firebase.Promise < any > ;
4454
emailVerified : boolean ;
@@ -71,25 +81,12 @@ declare namespace firebase {
7181
interface UserInfo {
7282
displayName : string | null ;
7383
email : string | null ;
84+
phoneNumber : string | null ;
7485
photoURL : string | null ;
7586
providerId : string ;
7687
uid : string ;
7788
}
7889

79-
type NextFn<V> = (value: V | null) => void;
80-
81-
type ErrorFn<E> = (error: E) => void;
82-
83-
type CompleteFn = () => void;
84-
85-
type Unsubscribe = () => void;
86-
87-
interface Observer<V, E> {
88-
next?: NextFn<V>;
89-
error?: ErrorFn<E>;
90-
complete?: CompleteFn;
91-
}
92-
9390
function app (name ? : string ) : firebase.app.App ;
9491

9592
var apps : ( firebase.app.App | null ) [] ;
@@ -137,9 +134,10 @@ declare namespace firebase.auth {
137134
currentUser : firebase.User | null ;
138135
fetchProvidersForEmail (email : string ) : firebase.Promise < any > ;
139136
getRedirectResult ( ) : firebase.Promise < any > ;
140-
onAuthStateChanged (nextOrObserver : firebase.Observer<firebase.User, firebase.auth.Error> | firebase.NextFn<firebase.User>, error ? : firebase.ErrorFn<firebase.auth.Error> , completed ? : firebase.CompleteFn ) : firebase.Unsubscribe ;
141-
onIdTokenChanged (nextOrObserver : firebase.Observer<firebase.User, firebase.auth.Error> | firebase.NextFn<firebase.User>, error ? : firebase.ErrorFn<firebase.auth.Error> , completed ? : firebase.CompleteFn ) : firebase.Unsubscribe ;
137+
onAuthStateChanged (nextOrObserver : firebase.Observer < any , any > | ( (a : firebase.User | null ) => any ) , error ? : (a : firebase.auth.Error ) => any , completed ? : firebase.Unsubscribe ) : firebase.Unsubscribe ;
138+
onIdTokenChanged (nextOrObserver : firebase.Observer < any , any > | ( (a : firebase.User | null ) => any ) , error ? : (a : firebase.auth.Error ) => any , completed ? : firebase.Unsubscribe ) : firebase.Unsubscribe ;
142139
sendPasswordResetEmail (email : string ) : firebase.Promise < any > ;
140+
setPersistence (persistence : firebase.auth.Auth.Persistence ) : firebase.Promise < any > ;
143141
signInAndRetrieveDataWithCredential (credential : firebase.auth.AuthCredential ) : firebase.Promise < any > ;
144142
signInAnonymously ( ) : firebase.Promise < any > ;
145143
signInWithCredential (credential : firebase.auth.AuthCredential ) : firebase.Promise < any > ;
@@ -240,6 +238,15 @@ declare namespace firebase.auth {
240238
type UserCredential = { additionalUserInfo ? : firebase.auth.AdditionalUserInfo | null , credential : firebase.auth.AuthCredential | null , operationType ? : string | null , user : firebase.User | null } ;
241239
}
242240

241+
declare namespace firebase.auth.Auth {
242+
type Persistence = string ;
243+
var Persistence : {
244+
LOCAL : Persistence ,
245+
NONE : Persistence ,
246+
SESSION : Persistence ,
247+
};
248+
}
249+
243250
declare namespace firebase.database {
244251
interface DataSnapshot {
245252
child (path : string ) : firebase.database.DataSnapshot ;
@@ -296,6 +303,7 @@ declare namespace firebase.database {
296303
key : string | null ;
297304
onDisconnect ( ) : firebase.database.OnDisconnect ;
298305
parent : firebase.database.Reference | null ;
306+
path : string ;
299307
push (value ? : any , onComplete ? : (a : Error | null ) => any ) : firebase.database.ThenableReference ;
300308
remove (onComplete ? : (a : Error | null ) => any ) : firebase.Promise < any > ;
301309
root : firebase.database.Reference ;
@@ -320,8 +328,8 @@ declare namespace firebase.messaging {
320328
interface Messaging {
321329
deleteToken (token : string ) : firebase.Promise < any > | null ;
322330
getToken ( ) : firebase.Promise < any > | null ;
323-
onMessage (nextOrObserver : firebase.Observer<Object, void> | firebase.NextFn<Object> ) : firebase.Unsubscribe ;
324-
onTokenRefresh (nextOrObserver : firebase.Observer<Object, void> | firebase.NextFn<Object> ) : firebase.Unsubscribe ;
331+
onMessage (nextOrObserver : firebase.Observer < any , any > | ( (a : Object ) => any ) ) : firebase.Unsubscribe ;
332+
onTokenRefresh (nextOrObserver : firebase.Observer < any , any > | ( (a : Object ) => any ) ) : firebase.Unsubscribe ;
325333
requestPermission ( ) : firebase.Promise < any > | null ;
326334
setBackgroundMessageHandler (callback : (a : Object ) => any ) : any ;
327335
useServiceWorker (registration : any ) : any ;
@@ -406,8 +414,7 @@ declare namespace firebase.storage {
406414
interface UploadTask {
407415
cancel ( ) : boolean ;
408416
catch (onRejected : (a : Error ) => any ) : firebase.Promise < any > ;
409-
on (event : firebase.storage.TaskEvent ) : ( nextOrObserver ? : firebase.Observer<firebase.storage.UploadTaskSnapshot, Error> | firebase.NextFn<firebase.storage.UploadTaskSnapshot> , error ? : firebase.ErrorFn<Error> | null , complete ? : firebase.CompleteFn | null ) => firebase.Unsubscribe ;
410-
on (event : firebase.storage.TaskEvent , nextOrObserver ? : firebase.Observer<firebase.storage.UploadTaskSnapshot, Error> | firebase.NextFn<firebase.storage.UploadTaskSnapshot> , error ? : firebase.ErrorFn<Error> | null , complete ? : firebase.CompleteFn | null ) : firebase.Unsubscribe ;
417+
on (event : firebase.storage.TaskEvent , nextOrObserver ? : firebase.Observer < any , any > | null | ( (a : Object ) => any ) , error ? : ( (a : Error ) => any ) | null , complete ? : ( firebase.Unsubscribe ) | null ) : Function ;
411418
pause ( ) : boolean ;
412419
resume ( ) : boolean ;
413420
snapshot : firebase.storage.UploadTaskSnapshot ;

‎typings/firebase.d.ts

+27-20
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,21 @@
1414
* limitations under the License.
1515
*/
1616
declare namespace firebase {
17+
type CompleteFn = ( ) => undefined ;
18+
1719
interface FirebaseError {
1820
code : string ;
1921
message : string ;
2022
name : string ;
2123
stack ? : string ;
2224
}
2325

26+
interface Observer < V , E > {
27+
complete ( ) : any ;
28+
error (error : E ) : any ;
29+
next (value : V | null ) : any ;
30+
}
31+
2432
class Promise < T > extends Promise_Instance < T > {
2533
static all (values : firebase.Promise < any > [] ) : firebase.Promise < any [] > ;
2634
static reject (error : Error ) : firebase.Promise < any > ;
@@ -39,6 +47,8 @@ declare namespace firebase {
3947
then (onResolve ? : (a : T ) => any , onReject ? : (a : Error ) => any ) : firebase.Thenable < any > ;
4048
}
4149

50+
type Unsubscribe = ( ) => undefined ;
51+
4252
interface User extends firebase.UserInfo {
4353
delete ( ) : firebase.Promise < any > ;
4454
emailVerified : boolean ;
@@ -71,25 +81,12 @@ declare namespace firebase {
7181
interface UserInfo {
7282
displayName : string | null ;
7383
email : string | null ;
84+
phoneNumber : string | null ;
7485
photoURL : string | null ;
7586
providerId : string ;
7687
uid : string ;
7788
}
7889

79-
type NextFn<V> = (value: V | null) => void;
80-
81-
type ErrorFn<E> = (error: E) => void;
82-
83-
type CompleteFn = () => void;
84-
85-
type Unsubscribe = () => void;
86-
87-
interface Observer<V, E> {
88-
next?: NextFn<V>;
89-
error?: ErrorFn<E>;
90-
complete?: CompleteFn;
91-
}
92-
9390
function app (name ? : string ) : firebase.app.App ;
9491

9592
var apps : ( firebase.app.App | null ) [] ;
@@ -137,9 +134,10 @@ declare namespace firebase.auth {
137134
currentUser : firebase.User | null ;
138135
fetchProvidersForEmail (email : string ) : firebase.Promise < any > ;
139136
getRedirectResult ( ) : firebase.Promise < any > ;
140-
onAuthStateChanged (nextOrObserver : firebase.Observer<firebase.User, firebase.auth.Error> | firebase.NextFn<firebase.User>, error ? : firebase.ErrorFn<firebase.auth.Error> , completed ? : firebase.CompleteFn ) : firebase.Unsubscribe ;
141-
onIdTokenChanged (nextOrObserver : firebase.Observer<firebase.User, firebase.auth.Error> | firebase.NextFn<firebase.User>, error ? : firebase.ErrorFn<firebase.auth.Error> , completed ? : firebase.CompleteFn ) : firebase.Unsubscribe ;
137+
onAuthStateChanged (nextOrObserver : firebase.Observer < any , any > | ( (a : firebase.User | null ) => any ) , error ? : (a : firebase.auth.Error ) => any , completed ? : firebase.Unsubscribe ) : firebase.Unsubscribe ;
138+
onIdTokenChanged (nextOrObserver : firebase.Observer < any , any > | ( (a : firebase.User | null ) => any ) , error ? : (a : firebase.auth.Error ) => any , completed ? : firebase.Unsubscribe ) : firebase.Unsubscribe ;
142139
sendPasswordResetEmail (email : string ) : firebase.Promise < any > ;
140+
setPersistence (persistence : firebase.auth.Auth.Persistence ) : firebase.Promise < any > ;
143141
signInAndRetrieveDataWithCredential (credential : firebase.auth.AuthCredential ) : firebase.Promise < any > ;
144142
signInAnonymously ( ) : firebase.Promise < any > ;
145143
signInWithCredential (credential : firebase.auth.AuthCredential ) : firebase.Promise < any > ;
@@ -240,6 +238,15 @@ declare namespace firebase.auth {
240238
type UserCredential = { additionalUserInfo ? : firebase.auth.AdditionalUserInfo | null , credential : firebase.auth.AuthCredential | null , operationType ? : string | null , user : firebase.User | null } ;
241239
}
242240

241+
declare namespace firebase.auth.Auth {
242+
type Persistence = string ;
243+
var Persistence : {
244+
LOCAL : Persistence ,
245+
NONE : Persistence ,
246+
SESSION : Persistence ,
247+
};
248+
}
249+
243250
declare namespace firebase.database {
244251
interface DataSnapshot {
245252
child (path : string ) : firebase.database.DataSnapshot ;
@@ -296,6 +303,7 @@ declare namespace firebase.database {
296303
key : string | null ;
297304
onDisconnect ( ) : firebase.database.OnDisconnect ;
298305
parent : firebase.database.Reference | null ;
306+
path : string ;
299307
push (value ? : any , onComplete ? : (a : Error | null ) => any ) : firebase.database.ThenableReference ;
300308
remove (onComplete ? : (a : Error | null ) => any ) : firebase.Promise < any > ;
301309
root : firebase.database.Reference ;
@@ -320,8 +328,8 @@ declare namespace firebase.messaging {
320328
interface Messaging {
321329
deleteToken (token : string ) : firebase.Promise < any > | null ;
322330
getToken ( ) : firebase.Promise < any > | null ;
323-
onMessage (nextOrObserver : firebase.Observer<Object, void> | firebase.NextFn<Object> ) : firebase.Unsubscribe ;
324-
onTokenRefresh (nextOrObserver : firebase.Observer<Object, void> | firebase.NextFn<Object> ) : firebase.Unsubscribe ;
331+
onMessage (nextOrObserver : firebase.Observer < any , any > | ( (a : Object ) => any ) ) : firebase.Unsubscribe ;
332+
onTokenRefresh (nextOrObserver : firebase.Observer < any , any > | ( (a : Object ) => any ) ) : firebase.Unsubscribe ;
325333
requestPermission ( ) : firebase.Promise < any > | null ;
326334
setBackgroundMessageHandler (callback : (a : Object ) => any ) : any ;
327335
useServiceWorker (registration : any ) : any ;
@@ -406,8 +414,7 @@ declare namespace firebase.storage {
406414
interface UploadTask {
407415
cancel ( ) : boolean ;
408416
catch (onRejected : (a : Error ) => any ) : firebase.Promise < any > ;
409-
on (event : firebase.storage.TaskEvent ) : ( nextOrObserver ? : firebase.Observer<firebase.storage.UploadTaskSnapshot, Error> | firebase.NextFn<firebase.storage.UploadTaskSnapshot> , error ? : firebase.ErrorFn<Error> | null , complete ? : firebase.CompleteFn | null ) => firebase.Unsubscribe ;
410-
on (event : firebase.storage.TaskEvent , nextOrObserver ? : firebase.Observer<firebase.storage.UploadTaskSnapshot, Error> | firebase.NextFn<firebase.storage.UploadTaskSnapshot> , error ? : firebase.ErrorFn<Error> | null , complete ? : firebase.CompleteFn | null ) : firebase.Unsubscribe ;
417+
on (event : firebase.storage.TaskEvent , nextOrObserver ? : firebase.Observer < any , any > | null | ( (a : Object ) => any ) , error ? : ( (a : Error ) => any ) | null , complete ? : ( firebase.Unsubscribe ) | null ) : Function ;
411418
pause ( ) : boolean ;
412419
resume ( ) : boolean ;
413420
snapshot : firebase.storage.UploadTaskSnapshot ;

0 commit comments

Comments
 (0)