JSPM

  • Created
  • Published
  • Downloads 15672
  • Score
    100M100P100Q142594F
  • License MIT

fetch client for aspida

Package Exports

  • @aspida/fetch
  • @aspida/fetch/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@aspida/fetch) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@aspida/fetch


aspida
fetch client for aspida.


Getting Started

Installation

  • Using npm:

    $ npm install @aspida/fetch
  • Using Yarn:

    $ yarn add @aspida/fetch

Make HTTP request from application

src/index.ts

import aspida, { HTTPError } from "@aspida/fetch"
import api from "../api/$api"

const fetchConfig = {
  credentials: "include",
  baseURL: "https://example.com/api",
  throwHttpErrors: true // throw an error on 4xx/5xx, default is false
}

const client = api(aspida(fetch, fetchConfig))
;(async () => {
  const userId = 0
  const limit = 10

  await client.v1.users.post({ name: "mario" })

  const res = await client.v1.users.get({ query: { limit } })
  console.log(res)
  // req -> GET: https://example.com/api/v1/users/?limit=10
  // res -> { status: 200, data: [{ id: 0, name: "mario" }], headers: {...} }

  try {
    const user = await client.v1.users._userId(userId).$get()
    console.log(user)
    // req -> GET: https://example.com/api/v1/users/0
    // res -> { id: 0, name: "mario" }
  } catch (e) {
    if (e instanceof HTTPError) {
      console.log(e.response instanceof Response) // true
    } else {
      console.log(e.message)
    }
  }
})()

Serialize GET parameters manually

src/index.ts

import aspida, { HTTPError } from "@aspida/fetch"
import qs from "qs"
import api from "../api/$api"

const fetchConfig = {
  paramsSerializer: params => qs.stringify(params)
}

const client = api(aspida(fetch, fetchConfig))
;(async () => {
  const users = await client.v1.users.$get({
    // config: { paramsSerializer: (params) => qs.stringify(params) },
    query: { ids: [1, 2, 3] }
  })
  console.log(users)
  // req -> GET: /v1/users/?ids%5B0%5D=1&ids%5B1%5D=2&ids%5B2%5D=3
  // decoded =>             ids[0]=1    &ids[1]=2    &ids[2]=3
  // res -> [{ id: 1, name: "taro1" }, { id: 2, name: "taro2" }, { id: 3, name: "taro3" }]
})()

License

@aspida/fetch is licensed under a MIT License.