@types/needle

What is @types/needle?

@types/needle provides TypeScript type definitions for the Needle HTTP client, which is a lightweight HTTP client for making HTTP requests in Node.js.

What are @types/needle's main functionalities?

Making GET Requests

This feature allows you to make GET requests to a specified URL and handle the response. The code sample demonstrates how to fetch a post from a placeholder API.

const needle = require('needle');

needle.get('https://jsonplaceholder.typicode.com/posts/1', (error, response) => {
  if (!error && response.statusCode == 200)
    console.log(response.body);
});

Making POST Requests

This feature allows you to make POST requests with a payload. The code sample demonstrates how to create a new post on a placeholder API.

const needle = require('needle');

const data = { title: 'foo', body: 'bar', userId: 1 };
needle.post('https://jsonplaceholder.typicode.com/posts', data, (error, response) => {
  if (!error && response.statusCode == 201)
    console.log(response.body);
});

Handling JSON Responses

This feature allows you to automatically parse JSON responses. The code sample demonstrates how to fetch a post and automatically parse the JSON response.

const needle = require('needle');

needle.get('https://jsonplaceholder.typicode.com/posts/1', { json: true }, (error, response) => {
  if (!error && response.statusCode == 200)
    console.log(response.body);
});

Setting Custom Headers

This feature allows you to set custom headers for your HTTP requests. The code sample demonstrates how to set a custom header for a GET request.

const needle = require('needle');

const options = { headers: { 'X-Custom-Header': 'foobar' } };
needle.get('https://jsonplaceholder.typicode.com/posts/1', options, (error, response) => {
  if (!error && response.statusCode == 200)
    console.log(response.body);
});

Other packages similar to @types/needle

axios

Axios is a promise-based HTTP client for the browser and Node.js. It provides a more modern and feature-rich API compared to Needle, including support for interceptors, automatic JSON transformation, and more.

request

Request is a simplified HTTP client for Node.js with a user-friendly API. It is more feature-rich than Needle but has been deprecated in favor of more modern alternatives like Axios.

got

Got is a lightweight and powerful HTTP request library for Node.js. It offers a more modern API and better performance compared to Needle, with built-in support for retries, streams, and more.

README

Installation

npm install --save @types/needle

Summary

This package contains type definitions for needle (https://github.com/tomas/needle).

Details

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

Additional Details

• Last updated: Wed, 18 Oct 2023 05:47:08 GMT
• Dependencies: @types/node

Credits

These definitions were written by San Chen, and Niklas Mollenhauer.