Add vcapServiceName configuration option to TS declarations.

Author: smithsz

CHANGES.md

@@ -1,14 +1,15 @@
 # UNRELEASED
 - [NEW] Added option for client to authenticate with IAM token server.
+- [FIXED] Add `vcapServiceName` configuration option to TS declarations.
 - [FIXED] Case where `.resume()` was called on an undefined response.
+- [FIXED] Updated the default IAM token server URL.
 - [BREAKING CHANGE] Nano 7 accepted a callback to the `*AsStream` functions, but
   the correct behaviour when using the `request` object from `*AsStream`
   functions is to use event handlers. Users of the `*AsStream` functions should
   ensure they are using event handlers not callbacks before moving to this
   version.
 - [UPGRADED] Apache CouchDB Nano to a minimum of version 8 for `*AsStream`
   function fixes.
-- [FIXED] Updated the default IAM token server URL.
 
 # 3.0.2 (2019-01-07)
 - [FIXED] Remove unnecessary `@types/nano` dependancy.

types/index.d.ts

@@ -1,4 +1,4 @@
-// Copyright © 2018 IBM Corp. All rights reserved.
+// Copyright © 2018, 2019 IBM Corp. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -33,6 +33,7 @@ declare namespace cloudant {
         password?: string;
         vcapInstanceName?: string;
         vcapServices?: string;
+        vcapServiceName?: string;
         url?: string;
         cookie?: string;
         requestDefaults?: CoreOptions;

types/tests.ts

@@ -1,4 +1,4 @@
-// Copyright © 2018 IBM Corp. All rights reserved.
+// Copyright © 2018, 2019 IBM Corp. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -28,6 +28,18 @@ const config: cloudant.Configuration = {
 
 const cfgInstance = cloudant(config);
 
+/*
+ * Instantiate with VCAP configuration object
+ */
+
+const vcapConfig: cloudant.Configuration = {
+    vcapInstanceName: 'foo',
+    vcapServiceName: 'cloudantXYZ',
+    vcapServices: JSON.parse(process.env.VCAP_SERVICES || '{}')
+};
+
+const vcapInstance = cloudant(vcapConfig);
+
 /*
  * Run Initialization Callback
  */