Referencia rápida

Chuleta de Superagent

Guía rápida de la librería cliente HTTP Superagent en JavaScript: peticiones GET y POST, cabeceras, cadenas de consulta y propiedades de respuesta.

· Publicado

Superagent es una librería progresiva y ligera para realizar peticiones HTTP en navegadores y Node.js.

Realización de peticiones

Petición 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)
  })

Estilo con promesas y 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)
}

Peticiones POST y cargas útiles JSON

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

Formularios Multipart y subida de archivos

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

Propiedades del objeto de respuesta

Propiedad Tipo Descripción
res.body Object Cuerpo de respuesta analizado (JSON / Formulario)
res.text String Texto de respuesta sin procesar
res.status Number Código de estado HTTP (p. ej. 200, 404)
res.header Object Cabeceras de la respuesta
res.ok Boolean Verdadero si el estado es 2xx
res.clientError Boolean Verdadero si el estado es 4xx
res.serverError Boolean Verdadero si el estado es 5xx
res.type String Content-Type sin parámetros adicionales

Temas relacionados