feat: $http.getBaseURL (#165)

nuxt · Feb 2, 2021 · 332bf34 · 332bf34
1 parent a6f2195
commit 332bf34
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 1 deletion.
diff --git a/docs/content/en/helpers.md b/docs/content/en/helpers.md
@@ -15,7 +15,7 @@ Helpers available on `$http` instance.
 
 - arguments: `(baseURL)`
 
-Globally set a header to all subsequent requests
+Globally set a base URL to all subsequent requests
 
 ```js
 // Set baseURL (both client and server)
@@ -32,6 +32,15 @@ if (process.server) {
 }
 ```
 
+## `getBaseURL`
+
+Get the value of the base URL
+
+```js
+// Get baseURL value
+this.$http.getBaseURL()
+```
+
 ## `setHeader`
 
 - arguments: `(name, value)`

diff --git a/lib/plugin.js b/lib/plugin.js
@@ -13,6 +13,10 @@ class HTTP {
     this._ky = ky
   }
 
+  getBaseURL () {
+    return this._defaults.prefixUrl
+  }
+
   setBaseURL (baseURL) {
     this._defaults.prefixUrl = baseURL
   }

diff --git a/test/fixture/pages/instance.vue b/test/fixture/pages/instance.vue
@@ -1,6 +1,7 @@
 <template>
   <div>
     <div>prefixUrl:{{ defaults.prefixUrl }}</div>
+    <div>baseURL:{{ baseURL }}</div>
     <div v-for="(value, key) in defaults.headers" :key="key">
       {{ key }}:{{ value }}
     </div>
@@ -11,6 +12,7 @@
 export default {
   asyncData ({ app: { $api } }) {
     return {
+      baseURL: $api.getBaseURL(),
       defaults: $api._defaults
     }
   }

diff --git a/test/module.test.js b/test/module.test.js
@@ -80,6 +80,7 @@ describe('module', () => {
     const html = await fetch(url('/instance')).then(r => r.text())
 
     expect(html).toContain('prefixUrl:https://jsonplaceholder.typicode.com/')
+    expect(html).toContain('baseURL:https://jsonplaceholder.typicode.com/')
     expect(html).toContain('testing:oui')
   })
 })
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -104,6 +104,12 @@ interface NuxtHTTPInstance {
 	$delete<T = unknown>(url: Request | URL | string, options?: Options): Promise<T>;
 
 
+  /**
+   * Get the baseURL value.
+   * @returns string - the base URL value
+   */
+  getBaseURL(): string
+
   /**
    * Set the baseURL for all subsequent requests.
    * @param baseURL - the base URL (e.g. `https://myapi.com/`)