Référence rapide

Aide-mémoire Superagent

Guide de référence rapide pour le client HTTP Superagent en JavaScript : requêtes GET et POST, en-têtes, requêtes et propriétés de réponse.

· Publié le

Superagent est une bibliothèque progressive et légère de requêtes HTTP pour le navigateur et Node.js.

Effectuer des requêtes

Requête GET

const superagent = require('superagent')

superagent
  .get('/api/users')
  .query({ role: 'admin', page: 2 })
  .set('Accept', 'application/json')
  .end((err, res) => {
    if (err) return console.error(err)
    console.log(res.status)
    console.log(res.body)
  })

Style Promesse et Async/Await

try {
  const res = await superagent
    .post('/api/users')
    .send({ name: 'John Doe', email: '[email protected]' })
    .set('Authorization', 'Bearer token123')

  console.log(res.body)
} catch (err) {
  console.error(err.response ? err.response.body : err.message)
}

Requêtes POST et données JSON

superagent
  .post('/api/items')
  .send({ item: 'Widget', qty: 10 })
  .set('X-API-Key', 'secret')
  .then(res => console.log(res.body))

Formulaires Multipart et téléversement de fichiers

superagent
  .post('/upload')
  .field('title', 'Profile Picture')
  .attach('avatar', 'path/to/avatar.png')
  .then(res => console.log('Uploaded!'))

Propriétés de l objet réponse

Propriété Type Description
res.body Object Corps de réponse analysé (JSON / Formulaire)
res.text String Texte brut non analysé de la réponse
res.status Number Code de statut HTTP (ex. 200, 404)
res.header Object En-têtes de réponse
res.ok Boolean Vrai si le statut est 2xx
res.clientError Boolean Vrai si le statut est 4xx
res.serverError Boolean Vrai si le statut est 5xx
res.type String Content-Type sans paramètres

Sujets associés