# igg-adonis-api-response

> Standard response igg

Latest version **1.4.0** (published 2024-08-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install igg-adonis-api-response
pnpm add igg-adonis-api-response
yarn add igg-adonis-api-response
bun add igg-adonis-api-response
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.4.0 |
| Published | 2024-08-15 |
| First published | 2020-02-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 3.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | banyawat, i-gear-geek, noppadol_la |

## Links

- npm: https://www.npmjs.com/package/igg-adonis-api-response
- Homepage: https://github.com/igeargeek/igg-adonis-api-response
- npm.io page: https://npm.io/package/igg-adonis-api-response

## Dependencies (1)

- [@adonisjs/fold](https://npm.io/package/@adonisjs/fold.md) 4.0.9

## Recent versions

- 1.4.0 (latest) — 2024-08-15
- 1.3.0 — 2024-08-14
- 1.2.1 — 2021-05-13
- 1.2.0 — 2021-02-09
- 1.1.3 — 2020-03-12
- 1.1.2 — 2020-03-12
- 1.0.2 — 2020-03-11
- 1.0.1 — 2020-03-11
- 1.0.0 — 2020-03-11
- 0.0.2 — 2020-02-06
- 0.0.1 — 2020-02-06

## README

# IGG Adonis standard response format

This extension only works for Adonis 4

## Installation

```
adonis install igg-adonis-api-response

# for yarn users
adonis install igg-adonis-api-response --yarn
```

## Registering provider

Make sure to register the soft deletes provider inside `start/app.js`

```js
const providers = ["igg-adonis-api-response/providers/ExtendResponseProvider"];
```

## Use

```js
Route.get("/response", ({ response }) => response.apiSuccess("some message"));
```

## Function

```js
unauthorized((message = "Unauthorized"));
paymentRequired((message = "Payment Required"));
notFound((message = "Not Found"));
badRequest((message = "Bad request"));
unprocessableEntity((message = "Unprocessable Entity"));
validateFailed((errorMessages = []), (message = "Validation failed"));
internalServerError((message = "Internal server error"));
apiCreated(item, (message = "Created successfully"));
apiUpdated(item, (message = "Updated successfully"));
apiDeleted((message = "No content"));
apiItem(item, (message = "Data retrieval successfully")); // response get by id
apiCollection(items, (message = "Data retrieval successfully")); // response get all
apiSuccess((message = "Success"), (data = null)); // response normal
apiPagination(data, (message = "Data retrieval successfully"));
```

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