Skip to content

Repository files navigation

This project is a Work in Progress and currently in development. The API is subject to change without warning.

Lightfetch Banner

A small fetching package for super simple usages.
Built using zero dependencies to be lightweight and asynchronous.
Lightfetch gives you the best of size, speed, and usability.


Install

npm install lightfetch-node

Usage

Main API

awaitlightfetch(url,[options]);

which returns a <Response>

Options

  • method: HTTP Request Method
  • headers: HTTP Headers to use in Request
  • body: Data to use in the Request*

* Data that can be used in body includes an Object, a string that's in x-www-form-urlencoded format, or plain text. Lightfetch will figure out what you pass in automagically and set the appropriate headers.

Response

The items in a response include:

  • <Response>.status: The status code of a response
  • <Response>.headers: The headers in a response
  • <Response>.cookies: The cookies in a response (uses an API similar to this internally)
  • <Response>.json: A function to parse the content of a response to JSON
  • <Response>.text: A function to parse the content of a response to text

If the above does not statisfy your needs, you can also use <Response>.response to access the unmodified, raw response NodeJS outputs.

Example

// using CommonJSconst{ lightfetch }=require('lightfetch-node');// using ESMimport{lightfetch}from'lightfetch-node';asyncfunctionfetch(url){constres=awaitlightfetch(url,{method: 'GET',headers: {'X-Requested-With': 'RayhanADev',},});console.log('Status:',res.status);console.log('Response:',res.toJSON());console.log('Cookies:',res.cookies);}fetch('https://postman-echo.com/get?foo=bar');

About

Zero dependencies, lightweight, and asynchronous https requests package.

Topics

Resources

Code of conduct

Contributing

Stars

10 stars

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages