@types/superagent

What is @types/superagent?

The @types/superagent package provides TypeScript type definitions for the superagent library, which is a lightweight, progressive AJAX API crafted for flexibility, readability, and a low learning curve. This package doesn't add any new functionality to superagent itself but allows TypeScript developers to use superagent in their projects with type checking, autocompletion, and other TypeScript benefits.

What are @types/superagent's main functionalities?

Making GET requests

This feature allows you to make GET requests to retrieve data from a specified resource. The code sample demonstrates how to make a simple GET request to '/api/pets' and log the response body.

import request from 'superagent';

request.get('/api/pets').then(res => {
  console.log(res.body);
});

Posting data

This feature enables you to send data to a server using POST requests. The code sample shows how to post data to '/api/pets', sending an object with the name and species of a pet, and then logging the response body.

import request from 'superagent';

request.post('/api/pets')
  .send({ name: 'Milo', species: 'cat' })
  .then(res => {
    console.log(res.body);
  });

Setting headers

This feature allows you to set custom headers for your requests. In the code sample, a GET request is made to '/api/pets' with a custom 'API-Key' header.

import request from 'superagent';

request.get('/api/pets')
  .set('API-Key', 'foobar')
  .then(res => {
    console.log(res.body);
  });

Other packages similar to @types/superagent

axios

Axios is a promise-based HTTP client for the browser and Node.js. It provides a simple API for making XMLHttpRequests and http requests. Compared to @types/superagent, Axios supports request and response interceptors, automatic transforms for JSON data, and client-side protection against XSRF.

node-fetch

node-fetch is a lightweight module that brings the Fetch API to Node.js. It aims to provide a consistent API with the browser's fetch API. Unlike @types/superagent, which is designed for use with superagent, node-fetch is more focused on mimicking the fetch API in Node.js environments.

got

Got is a human-friendly and powerful HTTP request library for Node.js. It supports retries, streams, and pagination out-of-the-box. Compared to @types/superagent, Got offers more advanced features like request retries, more comprehensive stream support, and built-in caching mechanisms.

README

Installation

npm install --save @types/superagent

Summary

This package contains type definitions for superagent (https://github.com/visionmedia/superagent).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/superagent.

Additional Details

• Last updated: Mon, 26 Aug 2024 02:45:06 GMT
• Dependencies: @types/cookiejar, @types/methods, @types/node, form-data

Credits

These definitions were written by Nico Zelaya, Michael Ledin, Shrey Jain, Alec Zopf, Adam Haglund, Lukas Elmer, Jesse Rogers, Chris Arnesen, Anders Kindberg, LuckyWind_sck, and David Tanner.