feat: public-readonly-method-for-getting-host-and-port

Closes #580

Author: vasco-santos

README.md

@@ -372,6 +372,12 @@ ipfs.util.addFromStream(<readable-stream>, (err, result) => {
 })
 ```
 
+##### Get endpoint configuration (host and port)
+
+> `ipfs.util.getEndpointConfig()`
+
+This returns an object containing the `host` and the `port`
+
 ### Callbacks and Promises
 
 If you do not pass in a callback all API functions will return a `Promise`. For example:

src/index.js

@@ -36,7 +36,7 @@ function IpfsAPI (hostOrMultiaddr, port, opts) {
   }
 
   const requestAPI = sendRequest(config)
-  const cmds = loadCommands(requestAPI)
+  const cmds = loadCommands(requestAPI, config)
   cmds.send = requestAPI
   cmds.Buffer = Buffer
 

src/util/get-endpoint-config.js

@@ -0,0 +1,8 @@
+'use strict'
+
+module.exports = (config) => {
+  return () => ({
+    host: config.host,
+    port: config.port
+  })
+}

src/utils/load-commands.js

@@ -55,24 +55,25 @@ function requireCommands () {
     return files
   }
 
-  cmds.util = function (send) {
+  cmds.util = function (send, config) {
     const util = {
       addFromFs: require('../util/fs-add')(send),
       addFromStream: require('../files/add')(send),
-      addFromURL: require('../util/url-add')(send)
+      addFromURL: require('../util/url-add')(send),
+      getEndpointConfig: require('../util/get-endpoint-config')(config)
     }
     return util
   }
 
   return cmds
 }
 
-function loadCommands (send) {
+function loadCommands (send, config) {
   const files = requireCommands()
   const cmds = {}
 
   Object.keys(files).forEach((file) => {
-    cmds[file] = files[file](send)
+    cmds[file] = files[file](send, config)
   })
 
   return cmds

test/util.spec.js

@@ -156,4 +156,13 @@ describe('.util', () => {
         .then(out => expectTimeout(ipfs.object.get(out[0].hash), 4000))
     })
   })
+
+  describe('.getEndpointConfig', () => {
+    it('should return the endpoint configured host and port', function () {
+      const endpoint = ipfs.util.getEndpointConfig()
+
+      expect(endpoint).to.have.property('host')
+      expect(endpoint).to.have.property('port')
+    })
+  })
 })