Update type definitions

Author: smithsz

types/index.d.ts

@@ -13,7 +13,7 @@
 // limitations under the License.
 
 import * as nano from 'nano';
-import { Request, CoreOptions } from "request";
+import CoreOptions from "request";
 
 declare function cloudant(
     config: cloudant.Configuration | string,
@@ -76,10 +76,10 @@ declare namespace cloudant {
 
     interface Query {
         // https://console.bluemix.net/docs/services/Cloudant/api/cloudant_query.html#query
-        (definition?: any, callback?: Callback<any>): Request;
+        (definition?: any, callback?: Callback<any>): Promise<any>;
 
         // https://console.bluemix.net/docs/services/Cloudant/api/cloudant_query.html#deleting-an-index
-        del(spec: QueryDeleteSpec, callback?: Callback<any>): Request;
+        del(spec: QueryDeleteSpec, callback?: Callback<any>): Promise<any>;
     }
 
     interface QueryDeleteSpec {
@@ -114,25 +114,25 @@ declare namespace cloudant {
         scope(db: string): DocumentScope<any>;
 
         // https://console.bluemix.net/docs/services/Cloudant/api/vhosts.html#creating-a-virtual-host
-        add_virtual_host(virtualHost: VirtualHost, callback?: Callback<any>): Request;
+        add_virtual_host(virtualHost: VirtualHost, callback?: Callback<any>): Promise<any>;
 
         // https://console.bluemix.net/docs/services/Cloudant/api/vhosts.html#deleting-a-virtual-host
-        delete_virtual_host(virtualHost: VirtualHost, callback?: Callback<any>): Request;
+        delete_virtual_host(virtualHost: VirtualHost, callback?: Callback<any>): Promise<any>;
 
         // https://console.bluemix.net/docs/services/Cloudant/api/authorization.html#api-keys
-        generate_api_key(callback?: Callback<ApiKey>): Request;
+        generate_api_key(callback?: Callback<ApiKey>): Promise<any>;
 
         // https://console.bluemix.net/docs/services/Cloudant/api/cors.html#reading-the-cors-configuration
-        get_cors(callback?: Callback<any>): Request;
+        get_cors(callback?: Callback<any>): Promise<any>;
 
         // https://console.bluemix.net/docs/services/Cloudant/api/vhosts.html#listing-virtual-hosts
-        get_virtual_hosts(callback?: Callback<any>): Request;
+        get_virtual_hosts(callback?: Callback<any>): Promise<any>;
 
         // https://console.bluemix.net/docs/services/Cloudant/api/account.html#ping
-        ping(callback?: Callback<any>): Request;
+        ping(callback?: Callback<any>): Promise<any>;
 
         // https://console.bluemix.net/docs/services/Cloudant/api/cors.html#setting-the-cors-configuration
-        set_cors(cors: CORS, callback?: Callback<any>): Request;
+        set_cors(cors: CORS, callback?: Callback<any>): Promise<any>;
     }
 
     // Document Scope
@@ -143,35 +143,35 @@ declare namespace cloudant {
         index: Query;
 
         // https://console.bluemix.net/docs/services/Cloudant/api/document.html#the-_bulk_get-endpoint
-        bulk_get(options: nano.BulkModifyDocsWrapper, callback?: Callback<any>): Request;
+        bulk_get(options: nano.BulkModifyDocsWrapper, callback?: Callback<any>): Promise<any>;
 
         // https://console.bluemix.net/docs/services/Cloudant/api/cloudant-geo.html#cloudant-geospatial
         geo(
             designname: string,
             docname: string,
             params: GeoParams,
             callback?: Callback<GeoResult>
-        ): Request;
+        ): Promise<any>;
 
         // https://console.bluemix.net/docs/services/Cloudant/api/authorization.html#viewing-permissions
-        get_security(callback?: Callback<Security>): Request;
+        get_security(callback?: Callback<Security>): Promise<any>;
 
         // https://console.bluemix.net/docs/services/Cloudant/api/search.html
         search(
             designname: string,
             searchname: string,
             params: SearchParams,
             callback: Callback<any>
-        ): Request;
+        ): Promise<any>;
         search(
             designname: string,
             searchname: string,
             params: any,
             callback?: Callback<any>
-        ): Request;
+        ): Promise<any>;
 
         // https://console.bluemix.net/docs/services/Cloudant/api/authorization.html#modifying-permissions
-        set_security(Security: Security, callback?: Callback<any>): Request;
+        set_security(Security: Security, callback?: Callback<any>): Promise<any>;
     }
 }
 

types/tests.ts

@@ -45,8 +45,10 @@ cloudant(config, (error, client, pong) => {
 const instance = cloudant('http://localhost:5984');
 
 instance.ping((pong) => {});
+instance.ping().then((pong) => {});
 
 instance.generate_api_key((error, key) => {});
+instance.generate_api_key().then((key) => {});
 
 const cors: cloudant.CORS = {
   allow_credentials: true,
@@ -55,16 +57,24 @@ const cors: cloudant.CORS = {
 };
 
 instance.set_cors(cors, (error, data) => {});
+instance.set_cors(cors).then((data) => {});
+
 instance.get_cors((error, data) => {});
+instance.get_cors().then((data) => {});
 
 const virtualHost: cloudant.VirtualHost = {
   host: 'www.example.com',
   path: 'the-path'
 };
 
 instance.add_virtual_host(virtualHost, (error, resp) => {});
+instance.add_virtual_host(virtualHost).then((resp) => {});
+
 instance.get_virtual_hosts((error, hosts) => {});
+instance.get_virtual_hosts().then((hosts) => {});
+
 instance.delete_virtual_host(virtualHost, (error, resp) => {});
+instance.delete_virtual_host(virtualHost).then((resp) => {});
 
 /*
  * Document Scope
@@ -77,21 +87,26 @@ const docs: nano.BulkModifyDocsWrapper = {
 };
 
 mydb.bulk_get(docs, (results) => {});
+mydb.bulk_get(docs).then((results) => {});
 
 const security: cloudant.Security = {
   nobody: [],
   nodejs : [ '_reader', '_writer', '_admin', '_replicator' ]
 };
 
 mydb.set_security(security, (error, resp) => {});
+mydb.set_security(security).then((resp) => {});
+
 mydb.get_security((err, resp) => {});
+mydb.get_security().then((resp) => {});
 
 const params: cloudant.SearchParams = {
   limit: 10,
   q: 'bird:*'
 };
 
 mydb.search('design', 'doc', params, (err, resp) => {});
+mydb.search('design', 'doc', params).then((resp) => {});
 
 const geoParams: cloudant.GeoParams = {
   include_docs: true,
@@ -100,20 +115,27 @@ const geoParams: cloudant.GeoParams = {
 };
 
 mydb.geo('design', 'docname', geoParams, (err, result) => {});
+mydb.geo('design', 'docname', geoParams).then((result) => {});
 
 const myIndex = {
   index: { fields: [ 'foo' ] },
   name: 'foo-index',
   type: 'json'
 };
 
-mydb.index(myIndex, (err, resp) => {}); // create index
+// Create an index.
+mydb.index(myIndex, (err, resp) => {});
+mydb.index(myIndex).then((resp) => {});
 
-mydb.index((err: any, resp: any) => {}); // see all indexes
+// See all indexes.
+mydb.index((err: any, resp: any) => {});
+mydb.index().then((resp) => {});
 
 const myDeleteSpec: cloudant.QueryDeleteSpec = {
     ddoc: '_design/1f003ce73056238720c2e8f7da545390a8ea1dc5',
     name: 'foo-index'
 };
 
-mydb.index.del(myDeleteSpec, (err, resp) => {}); // delete index
+// Delete an index.
+mydb.index.del(myDeleteSpec, (err, resp) => {});
+mydb.index.del(myDeleteSpec).then((resp) => {});