Merge pull request #295 from cloudant/291-fix-ts-cloudant-init

291 fix ts cloudant init

Author: smithsz

CHANGES.md

@@ -1,5 +1,6 @@
 # UNRELEASED
 - [FIXED] Add missing `maxAttempt` parameter to TypeScript definition.
+- [FIXED] Include client initialization callback in TypeScript definition.
 - [FIXED] Removed test and lint data that bloated npm package size.
 - [FIXED] Support Cloudant query when using promises request plugin.
 

README.md

@@ -784,8 +784,7 @@ type. For example:
 ```js
 import * as Cloudant from '@cloudant/cloudant';
 
-var cloudant = Cloudant({ account: 'me', password: 'password', plugins: [ 'promises' ] });
-var client = cloudant as Cloudant.ServerScope;
+var client = Cloudant({ account: 'me', password: 'password', plugins: [ 'promises' ] });
 
 (client.db.list() as any).then((d) => { console.log(d); });
 ```

types/index.d.ts

@@ -16,8 +16,9 @@ import * as nano from 'nano';
 import { Request, CoreOptions } from "request";
 
 declare function cloudant(
-    config: cloudant.Configuration | string
-): cloudant.ServerScope | cloudant.DocumentScope<any>;
+    config: cloudant.Configuration | string,
+    callback?: (error: any, client?: cloudant.ServerScope, pong?: any) => void
+): cloudant.ServerScope;
 
 declare namespace cloudant {
     type Callback<R> = (error: any, response: R, headers?: any) => void;

types/tests.ts

@@ -27,12 +27,21 @@ const config: cloudant.Configuration = {
 
 const cfgInstance = cloudant(config);
 
+/*
+ * Run Initialization Callback
+ */
+cloudant(config, (error, client, pong) => {
+  if (error) {
+    return;
+  } else if (client) {
+    client.db.list((error, allDbs) => {});
+  }
+});
+
 /*
  * Server Scope
  */
-const instance =  <cloudant.ServerScope> cloudant(
-  "http://localhost:5984/emails"
-);
+const instance = cloudant("http://localhost:5984");
 
 instance.ping((pong) => {});