brings v0.0.1-alpha.3

brings

A declarative type-safe HTTP fetching library

Installation

npm install brings

Usage

Basic GET request looks like this:

import brings from 'brings';

const data = await brings('https://jsonplaceholder.typicode.com/posts/1').trigger();

Here we did not specify any response parsing thus the data will be of type Blob. You can specify the response parsing by using the parse method:

import brings from 'brings';
import { json } from 'brings/parsers';

const data = await brings('https://jsonplaceholder.typicode.com/posts/1')
  .parse(json())
  .trigger();

Now the data will be of type unknown as the json parser does not know the shape of the data. You can specify the type of the data by using the generic type parameter:

interface Post {
  userId: number;
  id: number;
  title: string;
  body: string;
}

const data = await brings('https://jsonplaceholder.typicode.com/posts/1')
  .parse(json<Post>())
  .trigger();

Now the data will be of type Post.

Data transformation

Sometimes you want to immediately transform the received data to your own format. You can do this by using the map method:

const data = await brings('https://jsonplaceholder.typicode.com/posts/1')
  .parse(json<Post>().map((post) =>({
    ...post,
    title: post.title.toUpperCase(),
  })))
  .trigger();

You can also specify standard request options like headers, method and body:

const data = await brings('https://jsonplaceholder.typicode.com/posts/1')
  .method('GET')
  .header('Content-Type', 'application/json')
  .parse(json<Post>())
  .trigger();