Security News
Weekly Downloads Now Available in npm Package Search Results
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
@sapphire/fetch
Advanced tools
Tiny wrapper around globalThis.fetch for improved TypeScript and data type support
Tiny wrapper around Node's global fetch
for improved TypeScript and data type support
Table of Contents
Node has a great global fetch
(powered by undici) for making API calls, but because it focuses solely on bringing the Fetch API to Node.js, it doesn't provide specific error messages and handling for different return types (JSON, Buffer, plain text, etc). This is where @sapphire/fetch
comes in. The syntax is more restrictive than that of undici, but that makes it consistent and easier to use in TypeScript.
enum
for the common return data typesfetch
, which for NodeJS is undici and for browsers is the Fetch APIYou can use the following command to install this package, or replace npm install
with your package manager of choice.
npm install @sapphire/fetch
[!NOTE] While this section uses
import
, it maps 1:1 with CommonJS' require syntax. For example,
import { fetch } from '@sapphire/fetch';
is the same as
const { fetch } = require('@sapphire/fetch');
[!IMPORTANT] When providing a serializable object to the
body
option,@sapphire/fetch
will automatically callJSON.stringify
on the object. This means you can pass an object directly to thebody
option without having to callJSON.stringify
yourself. If the body is not serializable (such as aFile
,Buffer
, orBlob
), the body will be sent as-is. Serializability is calculated based on:
- If the body is
null
- If the body's
.constructor
property isundefined
- If the body's
.constructor.name
property isObject
- If the body has a function property named
toJSON
[!WARNING] Because
@sapphire/fetch
aims to be as close to global fetch as possible, it doesn't support proxy options that a library like undici does. If you want to use a proxy, you should use undici directly.
GET
ting JSON data// Import the fetch function
import { fetch, FetchResultTypes } from '@sapphire/fetch';
interface JsonPlaceholderResponse {
userId: number;
id: number;
title: string;
completed: boolean;
}
// Fetch the data. No need to call `.json()` after making the request!
const data = await fetch<JsonPlaceholderResponse>('https://jsonplaceholder.typicode.com/todos/1', FetchResultTypes.JSON);
// Do something with the data
console.log(data.userId);
GET
ting Buffer data (images, etc.)// Import the fetch function
import { fetch, FetchResultTypes } from '@sapphire/fetch';
// Fetch the data. No need to call `.buffer()` after making the request!
const sapphireLogo = await fetch('https://github.com/sapphiredev.png', FetchResultTypes.Buffer);
// sapphireLogo is the `Buffer` of the image
console.log(sapphireLogo);
POST
ing JSON data// Import the fetch function
import { fetch, FetchResultTypes, FetchMethods } from '@sapphire/fetch';
// Post the data. No need to call `.json()` after making the request!
const responseData = await fetch(
'https://jsonplaceholder.typicode.com/todos',
{
method: FetchMethods.Post,
headers: {
'Content-Type': 'application/json'
},
body: { name: 'John Doe' }
},
FetchResultTypes.JSON
);
// Do something with the response data
console.log(responseData);
Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!
We accept donations through Open Collective, Ko-fi, PayPal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.
Donate With | Address |
---|---|
Open Collective | Click Here |
Ko-fi | Click Here |
Patreon | Click Here |
PayPal | Click Here |
Please make sure to read the Contributing Guide before making a pull request.
Thank you to all the people who already contributed to Sapphire!
FAQs
Tiny wrapper around globalThis.fetch for improved TypeScript and data type support
The npm package @sapphire/fetch receives a total of 3,271 weekly downloads. As such, @sapphire/fetch popularity was classified as popular.
We found that @sapphire/fetch demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.