Skip to content

Commit 0e2b69e

Browse files
authored
fixed TypeScript definitions for follow functions - fixes issue #194 (#206)
1 parent 530cc60 commit 0e2b69e

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

lib/nano.d.ts

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,16 @@ declare namespace nano {
4444
updates(callback?: Callback<DatabaseUpdatesResponse>): Promise<DatabaseUpdatesResponse>;
4545
// http://docs.couchdb.org/en/latest/api/server/common.html#get--_db_updates
4646
updates(params: UpdatesParams, callback?: Callback<DatabaseUpdatesResponse>): Promise<DatabaseUpdatesResponse>;
47-
followUpdates(callback?: Callback<any>): EventEmitter;
48-
followUpdates(params: any, callback?: Callback<any>): EventEmitter;
47+
followUpdates(params?: any): FollowEmitter;
48+
followUpdates(callback: Callback<any>);
49+
followUpdates(params: any, callback: Callback<any>);
4950
uuids(num: number, callback?: Callback<any>): Promise<UUIDObject>;
5051
}
5152

53+
interface FollowEmitter extends EventEmitter {
54+
follow();
55+
}
56+
5257
interface UUIDObject {
5358
uuids: string[]
5459
}
@@ -99,9 +104,11 @@ declare namespace nano {
99104
changesAsStream(name: string): Request;
100105
// http://docs.couchdb.org/en/latest/api/database/compact.html#post--db-_compact
101106
changesAsStream(name: string, params: DatabaseChangesParams): Request;
102-
follow(source: string, callback?: Callback<any>): EventEmitter;
103-
follow(source: string, params: DatabaseScopeFollowUpdatesParams, callback?: Callback<any>): EventEmitter;
104-
followUpdates(params?: any, callback?: Callback<any>): EventEmitter;
107+
follow(source: string, params?: DatabaseScopeFollowUpdatesParams): FollowEmitter;
108+
follow(source: string, params: DatabaseScopeFollowUpdatesParams, callback: Callback<any>);
109+
followUpdates(params?: any): FollowEmitter;
110+
followUpdates(params: DatabaseScopeFollowUpdatesParams, callback: Callback<any>);
111+
followUpdates(callback: Callback<any>);
105112
// http://docs.couchdb.org/en/latest/api/server/common.html#get--_db_updates
106113
updates(callback?: Callback<DatabaseUpdatesResponse>): Promise<DatabaseUpdatesResponse>;
107114
// http://docs.couchdb.org/en/latest/api/server/common.html#get--_db_updates
@@ -129,8 +136,9 @@ declare namespace nano {
129136
changes(callback?: Callback<DatabaseChangesResponse>): Promise<DatabaseChangesResponse>;
130137
// http://docs.couchdb.org/en/latest/api/database/changes.html#get--db-_changes
131138
changes(params: DatabaseChangesParams, callback?: Callback<DatabaseChangesResponse>): Promise<DatabaseChangesResponse>;
132-
follow(callback?: Callback<any>): EventEmitter;
133-
follow(params: DocumentScopeFollowUpdatesParams, callback?: Callback<any>): EventEmitter;
139+
follow(params?: DocumentScopeFollowUpdatesParams): FollowEmitter;
140+
follow(params: DocumentScopeFollowUpdatesParams, callback: Callback<any>);
141+
follow(callback: Callback<any>);
134142
// http://docs.couchdb.org/en/latest/api/server/authn.html#cookie-authentication
135143
auth(username: string, userpass: string, callback?: Callback<DatabaseAuthResponse>): Promise<DatabaseAuthResponse>;
136144
// http://docs.couchdb.org/en/latest/api/server/authn.html#get--_session

0 commit comments

Comments
 (0)