JSPM

  • Created
  • Published
  • Downloads 1832
  • Score
    100M100P100Q111994F
  • License MIT

A useful axios helper

Package Exports

  • @varlet/axle
  • @varlet/axle/use

Readme

Intro

A tool library based on axios to simplify the development process

Quickstart

Install

# Install with npm, yarn or pnpm

# npm
npm i @varlet/axle -S

#yarn
yarn add @varlet/axle

#pnpm
pnpm add @varlet/axle

Request Call

import { createAxle } from '@varlet/axle'

// create axle instance
const axle = createAxle(/** @see https://axios-http.com **/)

// The built-in axios of the axle, the usage is exactly the same as that of axios, and shares the configuration with the axle.
const { axios } = axle

const response = await axle.get('/user', { current: 1, pageSize: 10 }, { headers: {} })
const response = await axle.post('/user', { name: 'Axle' }, { headers: {} })

Vue Composition Api

<script setup>
import { createAxle } from '@varlet/axle'
import { createUseAxle } from '@varlet/axle/use'

const axle = createAxle(/** @see https://axios-http.com **/)
const useAxle = createUseAxle(/** @see https://github.com/varletjs/axle/blob/main/src/use.ts?plain=1#L5 **/)

// default immediate request
const [users, getUsers, loading, { error }] = useAxle({
  /** @see https://github.com/varletjs/axle/blob/main/src/use.ts?plain=1#L26 **/
  runner: axle.get,
  url: '/user',
  params: { current: 1, pageSize: 10 },
  config: { headers: {} }
})
</script>

<template>
   <span>{{ users }}</span>
   <span>{{ loading }}</span>
   <span>{{ error }}</span>
</template>

Repo Status

WIP and Trying