Superagent with absolute url prefix

Question

I've noticed that I'm writing http://localhost everytime I want to run a node test with superagent.

import superagent from 'superagent';

const request = superagent.agent();
request
  .get('http://localhost/whatever')
  .end((err, res) => { ... });

Is there any way of avoiding the localhost part?

As far as I've gone is to avoid the request being hardcoded to the host:

const baseUrl = 'http://localhost:3030';

request
  .get(`${baseUrl}/whatever`)

But I still have to carry the baseUrl with the agent everytime.

David Michael Gregg · Answer 1 · 2023-06-21T22:22:52.750

3

While not so recently updated a package as superagent-absolute, superagent-prefix is officially recommended, and has the highest adoption as of 2020.

It is such a simple package that I would not be concerned with the lack of updates.

Example usage:

import superagent from "superagent"
import prefix from "superagent-prefix"

const baseURL = "https://foo.bar/api/"
const client = superagent
  .agent()
  .use(prefix(baseURL))

edited Jun 21 '23 at 22:22

answered Sep 22 '20 at 21:50

David Michael Gregg

270
2
11

"superagent.use is not a function". This no longer works – Joris Mans Jun 05 '23 at 15:40
1

@JorisMans Fixed. Thanks for the note. Superagent now requires an "agent" to be created explicitly, in order to maintain state for future requests. – David Michael Gregg Jun 21 '23 at 22:24

score 0 · Accepted Answer · answered Feb 26 '17 at 10:57

TL;DR: superagent-absolute does exactly that.

Detailed:

You can create one abstraction layer on top of superagent.

function superagentAbsolute(agent) {
  return baseUrl => ({
    get: url => url.startsWith('/') ? agent.get(baseUrl + url) : agent.get(url),
  });
}

⬑ That would override the agent.get when called with a starting /

global.request = superagentAbsolute(agent)('http://localhost:3030');

Now you would need to do the same for: DELETE, HEAD, PATCH, POST and PUT.

https://github.com/zurfyx/superagent-absolute/blob/master/index.js

const OVERRIDE = 'delete,get,head,patch,post,put'.split(',');
const superagentAbsolute = agent => baseUrl => (
  new Proxy(agent, {
    get(target, propertyName) {
      return (...params) => {
        if (OVERRIDE.indexOf(propertyName) !== -1 
            && params.length > 0 
            && typeof params[0] === 'string' 
            && params[0].startsWith('/')) {
          const absoluteUrl = baseUrl + params[0];
          return target[propertyName](absoluteUrl, ...params.slice(1));
        }
        return target[propertyName](...params);
      };
    },
  })
);

Or you can simply use superagent-absolute.

const superagent = require('superagent');
const superagentAbsolute = require('superagent-absolute');

const agent = superagent.agent();
const request = superagentAbsolute(agent)('http://localhost:3030');

it('should should display "It works!"', (done) => {
  request
    .get('/') // Requests "http://localhost:3030/".
    .end((err, res) => {
      expect(res.status).to.equal(200);
      expect(res.body).to.eql({ msg: 'It works!' });
      done();
    });
});

Superagent with absolute url prefix

2 Answers2

Linked