@uni-use/request v1.6.0-beta.1

@uni-use/request

An easy to use axios based http client combinatorial api with support for return sequentially

Installing

# use pnpm
$ pnpm install @uni-use/request

# use npm
$ npm install @uni-use/request --save

# use yarn
$ yarn add @uni-use/request

Usage

1. Simple use:

import useRequest from '@uni-use/request'

const {
  isFetching,
  error,
  data,
  execute,
  abort,
  canAbort,
  createFetch,
  isFinished,
  statusCode,
  response,
  aborted,
  onFetchResponse,
  onFetchError,
  onFetchFinally
} = useRequest({
  immediate,
  refetch,
  timeout,
  beforeFetch,
  afterFetch,
  onFetchResponse,
  onFetchError
})
  .get()
  .put()
  .post()
  .delete()
  .patch()
  .head()
  .options()
  //
  .json()
  .text()
  .blob()
  .arrayBuffer()
  .formData()

createFetch({
  baseUrl: 'https://my-api.com',
  options: {
    async beforeFetch({ options }) {
      const myToken = await getMyToken()
      options.headers.Authorization = `Bearer ${myToken}`

      return { options }
    }
  },
  fetchOptions: {
    mode: 'cors'
  }
})

request({
  url: '/path/of/api'
})

2. Using in vue3.x:

<script setup>
import useRequest from '@uni-use/request'

const { request } = useRequest({})

defineExpose({
  request
})
</script>

3. Using in vue2.7.x:

<script>
import useRequest from '@uni-use/request'

export default {
  setup() {
    const { request } = useRequest({})

    return {
      request
    }
  }
}
</script>

4. Use CDN resource

<script src="https://unpkg.com/vue-demi@latest/lib/index.iife.js"></script>
<script src="https://unpkg.com/@uni-use/request@1.0.0/dist/index.global.prod.js"></script>
<script>
  const { request } = useRequest({})
  // ...
</script>

Support & Issues

Please open an issue here.

License

MIT