Replace apiUrl by baseUrl.

Author: laurentpellegrino

.gitignore

@@ -1,5 +1,6 @@
 build/
 dist/
+docs/
 node_modules/
 typings/
 

CHANGELOG.md

@@ -10,6 +10,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [4.3.0] - 2021-12-14
 ### Added
 - New `parse` method in IpregistryClient for parsing user-agent header values.
+### Deprecated
+- Deprecate `IpregistryConfigBuilder.withApiUrl` in favor of `IpregistryConfigBuilder.withBaseUrl`. 
 
 ## [4.2.0] - 2021-10-26
 ### Added

package.json

@@ -45,7 +45,8 @@
     "lint": "./node_modules/.bin/tslint -p tsconfig.json",
     "prepack": "npm run clean && npm run build",
     "pretest": "npm run clean && npm run build",
-    "test:integration": "mocha -r ts-node/register integration_test/**/*.ts"
+    "test:integration": "mocha -r ts-node/register integration_test/**/*.ts",
+    "tsdoc": "yarn typedoc --out docs ./src/"
   },
   "author": "Ipregistry <support@ipregistry.co>",
   "devDependencies": {
@@ -56,6 +57,7 @@
     "mocha": "^9.1.3",
     "ts-node": "^10.4.0",
     "tslint": "^6.1.3",
+    "typedoc": "^0.22.10",
     "typescript": "^4.5.4",
     "webpack": "^5.65.0",
     "webpack-cli": "^4.9.1"
@@ -70,6 +72,6 @@
   "engines": {
     "node": ">=10.0.0"
   },
-  "engineStrict" : true,
+  "engineStrict": true,
   "private": false
 }

src/index.ts

@@ -26,15 +26,15 @@ export class IpregistryConfig {
 
     public readonly apiKey: string;
 
-    public readonly apiUrl: string = 'https://api.ipregistry.co';
+    public readonly baseUrl: string = 'https://api.ipregistry.co';
 
     public readonly timeout: number = 15000;
 
-    constructor(apiKey: string, apiUrl: string, timeout: number) {
+    constructor(apiKey: string, baseUrl: string, timeout: number) {
         this.apiKey = apiKey;
 
-        if (apiUrl) {
-            this.apiUrl = apiUrl;
+        if (baseUrl) {
+            this.baseUrl = baseUrl;
         }
 
         if (timeout) {
@@ -48,16 +48,24 @@ export class IpregistryConfigBuilder {
 
     private apiKey: string;
 
-    private apiUrl: string = 'https://api.ipregistry.co';
+    private baseUrl: string = 'https://api.ipregistry.co';
 
     private timeout: number = 15000;
 
     constructor(apiKey: string) {
         this.apiKey = apiKey;
     }
 
+    /*
+     * Use the new {@link IpregistryConfigBuilder.withBaseUrl} method instead.
+     */
     public withApiUrl(apiUrl: string): IpregistryConfigBuilder {
-        this.apiUrl = apiUrl;
+        this.baseUrl = apiUrl;
+        return this;
+    }
+
+    public withBaseUrl(baseUrl: string): IpregistryConfigBuilder {
+        this.baseUrl = baseUrl;
         return this;
     }
 
@@ -67,7 +75,7 @@ export class IpregistryConfigBuilder {
     }
 
     public build(): IpregistryConfig {
-        return new IpregistryConfig(this.apiKey, this.apiUrl, this.timeout);
+        return new IpregistryConfig(this.apiKey, this.baseUrl, this.timeout);
     }
 
 }

src/request.ts

@@ -246,7 +246,7 @@ export class DefaultRequestHandler implements IpregistryRequestHandler {
     }
 
     protected buildApiUrl(path: string, options?: IpregistryOption[]) {
-        let result = `${this.config.apiUrl}/${path ? path : ''}`;
+        let result = `${this.config.baseUrl}/${path ? path : ''}`;
 
         if (options) {
             let prefix = '?';