npm.io
1.0.2 • Published 4 years ago

use-vc-axios

Licence
ISC
Version
1.0.2
Deps
0
Size
6 kB
Vulns
0
Weekly
0
DeprecatedThis package is deprecated

Introduction

React library to work with axios more convenient.

Installation

You need to install Axios to support use-vc-axios
npm install axios
And you can install use-vc-axios
npm install use-vc-axios

Usage

Create apiInstance.js and export to call when using use-vc-axios

    import axios from "axios";
    const instance = axios.create({
        baseURL: 'https://example.com/api',
        headers: {
            "authorization":'Bearer YWxhZGRpbjpvcGVuc2VzYW1l'
        }
    });
    export default instance;

React

Call api instance
import instance from apiInstance.js

Call library
import { useVCAxios } from 'use-vc-axios'
import { useVCLazyAxios } from 'use-vc-axios'

useVCAxios example:

    import { useVCAxios } from 'use-vc-axios'
    import instance from 'apiInstance.js'
    const { data, loading, refetch } = useVCAxios({
            axiosInstance: instance,
            url: '/get/data',
            variables: {
                data:'test'
            },
            method:'POST'
    })

useVCLazyAxios example:

    import { useVCLazyAxios } from 'use-vc-axios'
    import instance from 'apiInstance.js'
    const { data, loading, operation } = useVCLazyAxios({
        axiosInstance: instance,
        url: '/get/data',

        method:'POST'
    })
    <button onClick={() => operation({variables:{data:'test'}})}>refetch</button>

API

useVCAxios:
axiosInstance: api which created in apiInstance.js axiosInstance: instance, Required
method: String GET | POST | PUT, Default GET
url: String, example: /get/data, which after base URL that'd defined in apiInstance.js, Required
variables: Object, data which send to url, Not required

response:
data: Response data from backend
loading: Boolean, Status of requesting true | false
error: Error data if any problem is happening
refetch: Function, to excute your method again

useVCLaxyAxios:
axiosInstance: api which created in apiInstance.js axiosInstance: instance, Required
method: String POST | PUT, Default POST
url: String, example: /post/data, which after base URL that'd defined in apiInstance.js, Required

response:
operation: Function, to trigger and send variables example: {data:'test'} to your method
data: Response data from backend
loading: Boolean, Status of requesting true | false
error: Error data if any problem is happening

Keywords