3.0.4 • Published 10 months ago

@sapphire/fetch v3.0.4

Weekly downloads
-
License
MIT
Repository
github
Last release
10 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.4-next.d8701971

10 months ago

3.0.5-next.79db3048

10 months ago

3.0.5-next.9b2d985c

10 months ago

3.0.4-next.4b7c3e6c

10 months ago

3.0.4

10 months ago

3.0.5-next.624d18f9

10 months ago

3.0.5-next.24be195f

10 months ago

3.0.4-next.bb6c8891

10 months ago

3.0.4-next.09afdaab

10 months ago

3.0.4-next.ba915f93

10 months ago

3.0.4-next.0cb1b7f1

10 months ago

3.0.4-next.279b1746

10 months ago

3.0.5-next.8490b4d9

10 months ago

3.0.4-next.78b93032

10 months ago

3.0.4-next.a6c8ccda

10 months ago

3.0.4-next.78c5a5bb

10 months ago

3.0.4-next.72e50e85

10 months ago

3.0.4-next.5ac3f246

10 months ago

3.0.4-next.0dce7d63

10 months ago

3.0.4-next.d8c5d05d

10 months ago

3.0.4-next.403a3afe

10 months ago

3.0.4-next.1e7d2dec

10 months ago

3.0.4-next.809c41ce

11 months ago

3.0.4-next.caddeb87

10 months ago

3.0.4-next.74c9ef24

11 months ago

3.0.4-next.acf54294

11 months ago

3.0.4-next.70feaf69

11 months ago

3.0.4-next.19790b8e

11 months ago

3.0.4-next.8627eb32

11 months ago

3.0.4-next.574c09c3

11 months ago

3.0.4-next.a133f01a

11 months ago

3.0.4-next.b913810f

11 months ago

3.0.4-next.86dab688

12 months ago

3.0.4-next.b97b30cd

12 months ago

3.0.4-next.fc35dd86

12 months ago

3.0.4-next.63feeab8

12 months ago

3.0.4-next.855b323f

12 months ago

3.0.4-next.6100b95e

12 months ago

3.0.4-next.8810833c

12 months ago

3.0.4-next.4a5bf954

12 months ago

3.0.4-next.f3243e67

12 months ago

3.0.4-next.5c8eaf07

12 months ago

3.0.4-next.98befbf8

12 months ago

3.0.3

1 year ago

3.0.4-next.1ac67e71

12 months 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

3 years ago

2.4.0

3 years ago

2.3.1

3 years ago

2.0.4

4 years ago

2.3.0

3 years ago

2.2.0

3 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

4 years ago

1.0.3

4 years ago

1.0.2

4 years ago

1.0.1

4 years ago

1.0.0

4 years ago