Git Product home page Git Product logo

req's Introduction

@zb81/req

npm version npm downloads bundle JSDocs License

Quick Start

1. Create an instance

import Request from '@zb81/req' // or import { Request } from '@zb81/req'

// biz error message
const ERROR_MSG = 'That\'s bad...'

// Instantiate with config and interceptors
const request = new Request({
  baseURL: 'https://httpbin.org',
  timeout: 10000,
  responseInterceptor(response) {
    if (Math.random() > 0.1) // biz error code
      throw new Error(ERROR_MSG) // you can throw the error, or show messages
    return response.data
  },
})

2. Declare types and req fn

interface Root<P> {
  args: P
  headers: Headers
  origin: string
  url: string
}

interface Headers {
  'Accept': string
  'Accept-Encoding': string
  'Host': string
  'User-Agent': string
  'X-Amzn-Trace-Id': string
}

function getRes(params: IParams) {
  return request.get<Root<IParams>>('/get', { params })
}

3. Invoke with type and await-to-js

import to from 'await-to-js'

const [res, err] = await to(getRes({ foo: 'bar' }))
if (!err)
  expect(res.args.foo).toBe('bar') // ๐Ÿš€
else
  expect(err.message).toBe(ERROR_MSG)

License

MIT License ยฉ 2024-PRESENT Zhu Bei

req's People

Contributors

zb81 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.