@cloudant/cloudant - npm Package Compare versions

Comparing version 4.2.3-SNAPSHOT.53 to 4.2.3-SNAPSHOT.54

CHANGES.md

 # UNRELEASED
 - [FIXED] Expose BasePlugin.
+- [IMPROVED] Documented the legacy compatibility behaviour that always adds the
+  `cookieauth` plugin when using the initialization callback functionality.
 
@@ -4,0 +6,0 @@ # 4.2.2 (2019-10-23)

package.json

@@ -10,3 +10,3 @@ {
   },
-  "version": "4.2.3-SNAPSHOT.53",
+  "version": "4.2.3-SNAPSHOT.54",
   "author": {
@@ -13,0 +13,0 @@ "name": "IBM Cloudant",

README.md

@@ -227,3 +227,3 @@ # Cloudant Node.js Client
 function. This will make the library automatically
-[ping](https://console.bluemix.net/docs/services/Cloudant/api/account.html#ping)
+[ping](https://cloud.ibm.com/docs/services/Cloudant/api?topic=cloudant-account#ping)
 Cloudant to confirm the connection and that your credentials work.
@@ -253,2 +253,21 @@
 
+**Note:** For legacy compatibility with older versions of the library using the
+initialization callback will always add the `cookieauth` plugin to the list of
+configured plugins. If you do not want to use `cookieauth` then you should not
+use this initialization callback, instead initalize the client without a
+callback and then call the [ping function](https://cloud.ibm.com/docs/services/Cloudant/api?topic=cloudant-account#ping)
+e.g.:
+
+```js
+const c = new Cloudant({
+  url: 'http://localhost:5984',
+  username: 'somebody',
+  password: 'something',
+  plugins: [] // disable cookieauth
+});
+c.ping()
+  .then(/* do something with response */ console.log)
+  .catch(/* handle error */ console.log);
+```
+
 ### Callback Signature
@@ -392,3 +411,3 @@
    users and control access to all cloud resources consistently in the IBM
-   Bluemix Cloud Platform.
+   Cloud Platform.
 
@@ -418,3 +437,3 @@ This plugin will automatically exchange your IAM API key for a token. It will
 
-   See [IBM Cloud Identity and Access Management](https://console.bluemix.net/docs/services/Cloudant/guides/iam.html#ibm-cloud-identity-and-access-management) for more information.
+   See [IBM Cloud Identity and Access Management](https://cloud.ibm.com/docs/services/Cloudant/guides?topic=cloudant-ibm-cloud-identity-and-access-management-iam-) for more information.
 
@@ -500,3 +519,3 @@ 3. `retry`
 the access control mechanisms offered by IBM Cloud IAM. See
-[here](https://console.bluemix.net/docs/services/Cloudant/guides/iam.html#ibm-cloud-identity-and-access-management-iam-)
+[here](https://cloud.ibm.com/docs/services/Cloudant/guides?topic=cloudant-ibm-cloud-identity-and-access-management-iam-)
 for more details.
@@ -1293,9 +1312,9 @@
 
-[Authentication]: https://console.bluemix.net/docs/services/Cloudant/api/authentication.html
-[Authorization]: https://console.bluemix.net/docs/services/Cloudant/api/authorization.html#authorization
-[CORS]: https://console.bluemix.net/docs/services/Cloudant/api/cors.html#cors
-[Cloudant Documentation]: https://console.bluemix.net/docs/services/Cloudant/cloudant.html#overview
-[Cloudant Geospatial]: https://console.bluemix.net/docs/services/Cloudant/api/cloudant-geo.html#cloudant-geospatial
-[Cloudant Query]: https://console.bluemix.net/docs/services/Cloudant/api/cloudant_query.html#query
-[Cloudant Search]: https://console.bluemix.net/docs/services/Cloudant/api/search.html
+[Authentication]: https://cloud.ibm.com/docs/services/Cloudant/api?topic=cloudant-authentication
+[Authorization]: https://cloud.ibm.com/docs/services/Cloudant/api?topic=cloudant-authorization
+[CORS]: https://cloud.ibm.com/docs/services/Cloudant/api?topic=cloudant-cors
+[Cloudant Documentation]: https://cloud.ibm.com/docs/services/Cloudant?topic=cloudant-overview
+[Cloudant Geospatial]: https://cloud.ibm.com/docs/services/Cloudant?topic=cloudant-cloudant-nosql-db-geospatial
+[Cloudant Query]: https://cloud.ibm.com/docs/services/Cloudant?topic=cloudant-query
+[Cloudant Search]: https://cloud.ibm.com/docs/services/Cloudant?topic=cloudant-search
 [Follow library]: https://github.com/cloudant-labs/cloudant-follow
@@ -1302,0 +1321,0 @@ [Issues]: https://github.com/cloudant/nodejs-cloudant/issues

No alert changes

Improved metrics

Total package byte prevSize

128350

increased by0.65%

Number of lines in readme file

1319

increased by1.46%

No dependency changes