envoc-request

envoc-request

Table of contents

Interfaces

• useAxiosRequestProps

Functions

• AxiosButton
• BlockingRequest
• Loadable
• Loading
• useAxiosRequest
• useAxiosService
• useService

Functions

AxiosButton

▸ AxiosButton(«destructured»): Element

Parameters

| Name | Type | | :------ | :------ | | «destructured» | Object | | › children | any | | › className | any | | › disabled | any | | › request | any |

Returns

Element

Defined in

components/AxiosButton.jsx:3

BlockingRequest

▸ BlockingRequest(«destructured»): any

Parameters

| Name | Type | | :------ | :------ | | «destructured» | Object | | › component | any | | › errorComponent | any | | › loadingComponent | any | | › render | any | | › unwrapResult | undefined | (resp: any) => any | | › webRequest | any |

Returns

any

Defined in

components/BlockingRequest.jsx: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 | | › request | any |

Returns

Element

Defined in

components/Loadable.jsx:7

Loading

▸ Loading(«destructured»): Element

A loading indicator which centers itself inside of its parent container

Parameters

| Name | Type | | :------ | :------ | | «destructured» | LoadingProps |

Returns

Element

Defined in

components/Loading.tsx:20

useAxiosRequest

▸ useAxiosRequest(«destructured»): Object

Parameters

| Name | Type | Default value | | :------ | :------ | :------ | | «destructured» | Object | undefined | | › autoExecute | undefined | boolean | true | | › onComplete | any | undefined | | › onError | any | undefined |

Returns

Object

| Name | Type | | :------ | :------ | | error | null | | loading | boolean | | resp | null | | submitRequest | () => void |

Defined in

hooks/useAxiosRequest.js:6

useAxiosService

▸ useAxiosService<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/useAxiosService.ts:63

▸ useAxiosService<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/useAxiosService.ts:67

▸ useAxiosService<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/useAxiosService.ts:72

useService

▸ useService<TService>(request, options?): UseServiceResult<RequestResult<TService>>

Type parameters

| Name | Type | | :------ | :------ | | TService | extends RequestWithoutParams<any> |

Parameters

| Name | Type | | :------ | :------ | | request | TService | | options? | RequestOptions |

Returns

UseServiceResult<RequestResult<TService>>

Defined in

hooks/useFetchService.tsx:57

▸ useService<TService, TParams, TResult>(request, params): UseServiceResult<RequestResult<TService>>

Type parameters

| Name | Type | | :------ | :------ | | TService | extends RequestWithParams<TParams, TResult> | | TParams | RequestParameter<TService> | | TResult | RequestResult<TService> |

Parameters

| Name | Type | | :------ | :------ | | request | TService | | params | RequestParameter<TService> |

Returns

UseServiceResult<RequestResult<TService>>

Defined in

hooks/useFetchService.tsx:61

▸ useService<TService, TParams, TResult>(request, params, options): UseServiceResult<RequestResult<TService>>

Type parameters

| Name | Type | | :------ | :------ | | TService | extends RequestWithParams<TParams, TResult> | | TParams | RequestParameter<TService> | | TResult | RequestResult<TService> |

Parameters

| Name | Type | | :------ | :------ | | request | TService | | params | RequestParameter<TService> | | options | RequestOptions |

Returns

UseServiceResult<RequestResult<TService>>

Defined in

hooks/useFetchService.tsx:69

Interfaces

envoc-request / useAxiosRequestProps

Interface: useAxiosRequestProps

Indexable

▪ [x: string]: any

Table of contents

Properties

• autoExecute
• cache
• maxAge
• method
• onComplete
• onError
• url

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