# envoc-request

> envoc-request

Latest version **4.7.0** (published 2025-06-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install envoc-request
pnpm add envoc-request
yarn add envoc-request
bun add envoc-request
```

## Health

**Score 40/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.7.0 |
| Published | 2025-06-25 |
| First published | 2020-06-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 74 KB |
| Known vulnerabilities | 0 (+22 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | envocdevelopers |
| Keywords | react-component |

## Links

- npm: https://www.npmjs.com/package/envoc-request
- npm.io page: https://npm.io/package/envoc-request

## Dependencies (3)

- [axios](https://npm.io/package/axios.md) ^0.30.0
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [object-hash](https://npm.io/package/object-hash.md) ^2.2.0

## Recent versions

- 4.7.0 (latest) — 2025-06-25
- 4.6.0 — 2025-04-02
- 4.5.0 — 2025-03-28
- 4.4.0 — 2025-03-28
- 6.0.1-3 — 2024-10-30
- 5.2.0 — 2024-10-30
- 6.0.1-2 — 2024-10-22
- 4.3.0 — 2024-10-19
- 4.2.0 — 2024-08-05
- 5.0.9 — 2024-07-09
- 6.0.1-1 — 2024-07-09
- 5.0.8 — 2024-05-29
- 5.0.7 — 2024-04-10
- 6.0.1-0 — 2024-04-10
- 5.0.4-0 — 2024-03-26
- … 64 more at https://npm.io/package/envoc-request/versions

## README

<a name="readmemd"></a>

envoc-request

# envoc-request

## Table of contents

### Interfaces

- [useAxiosRequestProps](#interfacesuseaxiosrequestpropsmd)

### Functions

- [AxiosButton](#axiosbutton)
- [BlockingRequest](#blockingrequest)
- [Loadable](#loadable)
- [Loading](#loading)
- [useAxiosRequest](#useaxiosrequest)
- [useService](#useservice)

## 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


<a name="interfacesuseaxiosrequestpropsmd"></a>

[envoc-request](#readmemd) / useAxiosRequestProps

## Interface: useAxiosRequestProps

### Indexable

▪ [x: `string`]: `any`

### Table of contents

#### Properties

- [autoExecute](#autoexecute)
- [cache](#cache)
- [maxAge](#maxage)
- [method](#method)
- [onComplete](#oncomplete)
- [onError](#onerror)
- [url](#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"`` \| ``"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

---
_Source: https://npm.io/package/envoc-request · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._