envoc-request
envoc-request
envoc-request
Table of contents
Interfaces
Functions
Functions
AxiosButton
▸ AxiosButton(__namedParameters): Element
Parameters
| Name | Type |
|---|---|
__namedParameters |
Object |
Returns
Element
Defined in
components/AxiosButton.js:4
BlockingRequest
▸ BlockingRequest(__namedParameters): any
Parameters
| Name | Type |
|---|---|
__namedParameters |
Object |
Returns
any
Defined in
components/BlockingRequest.js:4
Loadable
▸ Loadable(__namedParameters): Element
Renders a Loading indicator while waiting for a response from an axios request. The api matches that of the render and component props of a react-router Route.
Parameters
| Name | Type |
|---|---|
__namedParameters |
Object |
Returns
Element
Defined in
components/Loadable.js:8
Loading
▸ Loading(__namedParameters): Element
A loading indicator which centers itself inside of its parent container
Parameters
| Name | Type |
|---|---|
__namedParameters |
Object |
Returns
Element
Defined in
components/Loading.js:17
useAxiosRequest
▸ useAxiosRequest(__namedParameters): Object
Parameters
| Name | Type |
|---|---|
__namedParameters |
Object |
Returns
Object
| Name | Type |
|---|---|
error |
null |
loading |
boolean |
resp |
null |
submitRequest |
() => void |
Defined in
hooks/useAxiosRequest.js:6
useService
▸ useService<TService>(request): UseServiceResult<RequestResult<TService>>
Type parameters
| Name | Type |
|---|---|
TService |
extends RequestWithoutParams<any, TService> |
Parameters
| Name | Type |
|---|---|
request |
TService |
Returns
UseServiceResult<RequestResult<TService>>
Defined in
hooks/useService.ts:63
▸ useService<TService>(request, param): UseServiceResult<RequestResult<TService>>
Type parameters
| Name | Type |
|---|---|
TService |
extends GenericRequest |
Parameters
| Name | Type |
|---|---|
request |
TService |
param |
RequestParameter<TService> |
Returns
UseServiceResult<RequestResult<TService>>
Defined in
hooks/useService.ts:67
▸ useService<TService>(request, param, options): UseServiceResult<RequestResult<TService>>
Type parameters
| Name | Type |
|---|---|
TService |
extends GenericRequest |
Parameters
| Name | Type |
|---|---|
request |
TService |
param |
RequestParameter<TService> |
options |
RequestOptions |
Returns
UseServiceResult<RequestResult<TService>>
Defined in
hooks/useService.ts:72
Interfaces
envoc-request / useAxiosRequestProps
Interface: useAxiosRequestProps
Indexable
[x: string]: any
Table of contents
Properties
Properties
autoExecute
• Optional autoExecute: boolean
Defined in
hooks/useAxiosRequestProps.ts:9
cache
• Optional cache: any
Defined in
hooks/useAxiosRequestProps.ts:7
maxAge
• Optional maxAge: any
Defined in
hooks/useAxiosRequestProps.ts:8
method
• method: "get" | "post" | "put" | "delete"
Defined in
hooks/useAxiosRequestProps.ts:3
onComplete
• onComplete: any
Defined in
hooks/useAxiosRequestProps.ts:6
onError
• onError: any
Defined in
hooks/useAxiosRequestProps.ts:5
url
• url: string
Defined in
hooks/useAxiosRequestProps.ts:4