How to send query string parameters using supertest?

Question

I'm using supertest to send get query string parameters, how can I do that?

I tried

var imsServer = supertest.agent("https://example.com");

imsServer.get("/")
  .send({
    username: username,
    password: password,
    client_id: 'Test1',
    scope: 'openid,TestID',
    response_type: 'token',
    redirect_uri: 'https://example.com/test.jsp'
  })
  .expect(200) 
  .end(function (err, res) {
    // HTTP status should be 200
    expect(res.status).to.be.equal(200);
    body = res.body;
    userId = body.userId;
    accessToken = body.access_token;
    done();
  });

but that didn't send the parameters username, password, client_id as query string to the endpoint. Is there a way to send query string parameters using supertest?

score 79 · Answer 1 · edited Nov 05 '17 at 10:50

79

Although supertest is not that well documented, you can have a look into the tests/supertest.js.

There you have a test suite only for the query strings.

Something like:

request(app)
  .get('/')
  .query({ val: 'Test1' })
  .expect(200, function(err, res) {
    res.text.should.be.equal('Test1');
    done();
  });

Therefore:

.query({
  key1: value1,
  ...
  keyN: valueN
})

should work.

edited Nov 05 '17 at 10:50

rastasheep

8,266
3
25
36

answered Nov 01 '16 at 10:55

Robert T.

1,102
1
8
17

4

how silly that this simple function is not mentioned in the README. Makes me wonder if I am misunderstanding something about supertest. – vinhboy Mar 28 '17 at 21:59
11

@vinhboy Thats probably because supertest is just `superagent` with the added expect() function. If you look in superagent's docs https://visionmedia.github.io/superagent/ you can see the query function described with examples. – Prime_Aqasix May 13 '17 at 01:57
Update 2020, .query({k:v}) doesn't work with sails 1.0 and supertest 4.0.2. I had to ```.post('/users/data/?lang=in')``` to make it work – imsheth May 20 '20 at 08:51
1

@imsheth if you're using `post()`, then the corresponding function is `send()`, not `query()`. For example, try `.post('/users/data').send('lang=in')`. – nullromo Sep 02 '20 at 22:33

How to send query string parameters using supertest?

1 Answers1