@aspida/axios
TypeScript icon, indicating that this package has built-in type declarations

1.14.0 • Public • Published

@aspida/axios


aspida


axios client for aspida.


Getting Started

Installation

  • Using npm:

    $ npm install aspida @aspida/axios axios
  • Using Yarn:

    $ yarn add aspida @aspida/axios axios

Make HTTP request from application

src/index.ts

import axios from "axios";
import aspida from "@aspida/axios";
import api from "../api/$api";

const axiosConfig = { timeout: 3000, baseURL: "https://example.com/api" };
const client = api(aspida(axios, axiosConfig));
(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: {...} }

  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" }
})();

License

@aspida/axios is licensed under a MIT License.

Readme

Keywords

Package Sidebar

Install

npm i @aspida/axios

Weekly Downloads

15,286

Version

1.14.0

License

MIT

Unpacked Size

11.3 kB

Total Files

11

Last publish

Collaborators

  • m-mitsuhide
  • solufa