fix(APIClient): setUserAgent returns APIClient instance now

use the returned instance for method chaining

Author: KaiSchwarz-cnic

dist/apiclient.d.ts

@@ -14,7 +14,7 @@ export declare class APIClient {
     getPOSTData(cmd: any): string;
     getSession(): string | null;
     getURL(): string;
-    setUserAgent(str: string, rv: string): void;
+    setUserAgent(str: string, rv: string): APIClient;
     getUserAgent(): string;
     getVersion(): string;
     saveSession(session: any): APIClient;

dist/apiclient.js

@@ -130,14 +130,16 @@ export class APIClient {
      * Possibility to customize default user agent to fit your needs
      * @param str user agent label
      * @param rv revision of user agent
+     * @returns Current APIClient instance for method chaining
      */
-    public setUserAgent(str: string, rv: string) {
+    public setUserAgent(str: string, rv: string): APIClient {
         this.ua = (
             `${str} ` +
             `(${process.platform}; ${process.arch}; rv:${rv}) ` +
             `node-sdk/${this.getVersion()} ` +
             `node/${process.version}`
         );
+        return this;
     }
 
     /**

dist/apiclient.js.map

@@ -127,8 +127,9 @@ describe('APIClient class', function () {
 
   describe('#.setUserAgent', function () {
     it('validate response', function () {
-      cl.setUserAgent('WHMCS', '7.7.0')
+      const cls = cl.setUserAgent('WHMCS', '7.7.0')
       const ua = cl.getUserAgent()
+      expect(cls).to.be.instanceOf(apiclient.APIClient)
       expect(ua).to.equal(`WHMCS (${process.platform}; ${process.arch}; rv:7.7.0) node-sdk/${cl.getVersion()} node/${process.version}`)
     })
   })