envoc-request v5.0.7
envoc-request
envoc-request
Table of contents
Namespaces
Interfaces
Functions
Functions
AxiosButton
▸ AxiosButton(«destructured»
): Element
Parameters
Name | Type |
---|---|
«destructured» | Object |
Returns
Element
Defined in
components/AxiosButton.js:4
BlockingRequest
▸ BlockingRequest(«destructured»
): any
Parameters
Name | Type |
---|---|
«destructured» | Object |
Returns
any
Defined in
components/BlockingRequest.js:4
Loadable
▸ Loadable(«destructured»
): 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 |
---|---|
«destructured» | Object |
Returns
Element
Defined in
components/Loadable.js:8
Loading
▸ Loading(«destructured»
): Element
A loading indicator which centers itself inside of its parent container
Parameters
Name | Type |
---|---|
«destructured» | Object |
Returns
Element
Defined in
components/Loading.js:17
useAxiosRequest
▸ useAxiosRequest(«destructured»
): Object
Parameters
Name | Type |
---|---|
«destructured» | 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 > |
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"
| "delete"
| "post"
| "put"
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
Modules
envoc-request / Loading
Namespace: Loading
Table of contents
Variables
Variables
defaultProps
• defaultProps: Object
Type declaration
Name | Type |
---|---|
className | string |
style | {} |
Defined in
components/Loading.js:26
30 days ago
30 days ago
1 month ago
2 months ago
2 months ago
4 months ago
7 months ago
9 months ago
10 months ago
10 months ago
10 months ago
12 months ago
1 year ago
1 year ago
1 year ago
2 years ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago