3.0.5 โ€ข Published 9 months ago

@sapphire/fetch v3.0.5

Weekly downloads
-
License
MIT
Repository
github
Last release
9 months ago

Sapphire Logo

@sapphire/fetch

Tiny wrapper around node-fetch for improved TypeScript and data type support

GitHub codecov npm bundle size npm Depfu

Table of Contents

Description

node-fetch is already a great library 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 node-fetch, but that makes it consistent and easier to use in TypeScript.

Features

  • Written in TypeScript
  • Fully tested
  • Exported const enum for the common return data types.
  • Throws distinctive errors when the API returns a "not ok" status code to make them easier to understand.
  • Enforces casting the return type when requesting JSON data, to ensure your return data is strictly typed.

Installation

You can use the following command to install this package, or replace npm install with your package manager of choice.

npm install @sapphire/fetch

Node-fetch types

TypeScript users should also add @types/node-fetch:

npm install --save-dev @types/node-fetch

Alternatively, you can enable the skipLibChecks TypeScript compiler option

Usage

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').

Note: fetch can also be imported as a default import: import fetch from '@sapphire/fetch'.

GETting 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);

GETting 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);

POSTing JSON data

// Import the fetch function
import { fetch, FetchResultTypes, FetchMethods } from '@sapphire/fetch';

// Fetch 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: JSON.stringify({
			name: 'John Doe'
		})
	},
	FetchResultTypes.JSON
);

// Do something with the response data
console.log(responseData);

API Documentation

For the full API documentation please refer to the TypeDoc generated documentation.

Buy us some doughnuts

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 WithAddress
Open CollectiveClick Here
Ko-fiClick Here
PatreonClick Here
PayPalClick Here

Contributors โœจ

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

3.0.6-next.bab0bd45

10 months ago

3.0.6-next.beeba83b

10 months ago

3.0.6-next.41417ed2

11 months ago

3.0.6-next.2acce636

11 months ago

3.0.6-next.3b2a6fae

10 months ago

3.0.6-next.a6e68f30

11 months ago

3.0.6-next.cfb8940c

11 months ago

3.0.6-next.7dc50c72

10 months ago

3.0.6-next.e79994f1

11 months ago

3.0.6-next.a41a8cc4

10 months ago

3.0.6-next.a8df7770

11 months ago

3.0.6-next.c1d407e3

10 months ago

3.0.6-next.1b923add

11 months ago

3.0.6-next.44446bab

10 months ago

3.0.6-next.893fe544

10 months ago

3.0.6-next.2237f1c6

11 months ago

3.0.6-next.75165d36

11 months ago

3.0.5

1 year ago

3.0.6-next.bc2f01ce

12 months ago

3.0.6-next.1598a42e

11 months ago

3.0.6-next.7bb00e1e

11 months ago

3.0.6-next.d7167620

10 months ago

3.0.6-next.06bcc83c

11 months ago

3.0.6-next.87bbf48f

12 months ago

3.0.6-next.fb5ad246

10 months ago

3.0.6-next.4bc55911

11 months ago

3.0.6-next.12872de7

11 months ago

3.0.6-next.df204ea0

10 months ago

3.0.6-next.038daf1c

10 months ago

3.0.4

1 year ago

3.0.3

2 years ago

3.0.2

2 years ago

3.0.1

2 years ago

3.0.0

2 years ago

2.4.2

2 years ago

2.4.1

4 years ago

2.4.0

4 years ago

2.3.1

4 years ago

2.0.4

4 years ago

2.3.0

4 years ago

2.2.0

4 years ago

2.1.0

4 years ago

2.0.3

4 years ago

2.0.2

4 years ago

2.0.1

4 years ago

2.0.0

4 years ago

1.0.5

5 years ago

1.0.3

5 years ago

1.0.2

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago