How can I inject a custom HTTP Header into every request that SuperAgent makes?

Question

Clearly SuperAgent supports custom HTTP headers:

request
   .post('/api/pet')
   .send({ name: 'Manny', species: 'cat' })
   .set('X-API-Key', 'foobar')
   .set('Accept', 'application/json')
   .end(function(err, res){
     if (res.ok) {
       alert('yay got ' + JSON.stringify(res.body));
     } else {
       alert('Oh no! error ' + res.text);
     }
   });

My Question:

If I'm pulling down SuperAgent via npm, how can I inject my own HTTP header across all requests that SuperAgent makes?
Note: I'm entire willing to create a new npm package that extends SuperAgent if necessary.

Christopher Tarquini · Accepted Answer · 2015-07-20T08:38:02.040

25

I'd just make a separate module with something like this:

myagent.js

var superagent = require('superagent');

var defaultHeaders = {};
function isObject(obj) { return Object(obj) === obj; };

function request(method, url) {
   return superagent(method, url).set(defaultHeaders);
}

request.set = function (field, value) {
   if (isObject(field)) {
      for(var key in field) this.set(key, field[key]);
      return this;
   }
   defaultHeaders[field] = value;
   return this;
}
module.exports = request;

Usage

var request = require('./myagent');
request.set({'X-My-Header': 'foo'}); // sets the default

request.get('/bar').send() // will send the default header

The module behaves the same way as superagent but sets default headers before returning the Request object. See here

edited Jul 20 '15 at 08:38

answered Jul 20 '15 at 08:25

Christopher Tarquini

11,176
16
55
73

1

TypeError: request.get is not a function – Sunil Garg Nov 29 '17 at 10:17
how is that working for you? getting TypeError: request.get is not a function as well – Yazan Jaber Oct 19 '18 at 05:21
i think you need to provide the method as a string instead of request.get, try request('get', 'url').send() – Souparno Oct 28 '19 at 20:47

score 10 · Answer 2 · answered Nov 29 '17 at 12:31

This could be the late answer but I have used superagent-use plugin to inject a custom HTTP header in all the requests. First of all, you need to install superagent-use

npm install superagent-use --save

then require like this

// using plugin to intercept calls
var request = require('superagent-use')(require('superagent'));

then add the function as middlerware/interceptor

// interceptor used by superagent to add custom header for each request
request.use((req) => {
    req.header.custom_header = any_value;
    return req;
});

and finally

request
    .get(url)
    .query({ view: 'jsonView' }) // query string

score 4 · Answer 3 · answered Mar 21 '16 at 11:17

So in my case I needed to set a csrf token as default header in all my requests. You can write a simple wrapper function like this.

custom-agent.js

import SuperAgent from 'superagent';

const csrfToken = document.querySelector('meta[name=csrf-token]').content;

export default {
  fire(method, url) {
    return SuperAgent[method](url).set('X-CSRF-Token', csrfToken);
  }
};

Use it like this.

import Agent from './custom-agent'

Agent.fire('get', '/endpoint')
// => SuperAgent.get('/endpoint').set('X-CSRF-Token', csrfToken)

How can I inject a custom HTTP Header into every request that SuperAgent makes?

3 Answers3

myagent.js

Usage

Linked