# @henrotaymcorp/api-client-parser-addon

> api-client-parser-addon

Latest version **0.0.1** (published 2023-05-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @henrotaymcorp/api-client-parser-addon
pnpm add @henrotaymcorp/api-client-parser-addon
yarn add @henrotaymcorp/api-client-parser-addon
bun add @henrotaymcorp/api-client-parser-addon
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2023-05-16 |
| First published | 2023-05-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 8.2 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Henrotay Mathieu |
| Maintainers | henrotaym |

## Links

- npm: https://www.npmjs.com/package/@henrotaymcorp/api-client-parser-addon
- Repository: https://github.com/henrotaymcorp/api-client-parser-addon
- Homepage: https://github.com/henrotaymcorp/api-client-parser-addon#readme
- Issues: https://github.com/henrotaymcorp/api-client-parser-addon/issues
- npm.io page: https://npm.io/package/@henrotaymcorp/api-client-parser-addon

## Dependencies (2)

- [zod](https://npm.io/package/zod.md) ^3.21.4
- [@henrotaym/api-client](https://npm.io/package/@henrotaym/api-client.md) ^1.3.3

## Recent versions

- 0.0.1 (latest) — 2023-05-16

## README

# api-client-parser-addon
api-client-parser-addon

## Installation
```shell
yarn add @henrotaymcorp/api-client-parser-addon
```

## Usage
```typescript
import { Client, Request } from "@henrotaym/api-client";
import { ResponseStatus, useResponseParser } from "@henrotaymcorp/api-client-parser-addon";
import { z } from "zod";

// Defining response schema.
const responseSchema = z.object({
  document: z.object({
    name: z.string(),
    uuid: z.string(),
  }),
});

// Defining endpoint.
const fetchDocument = async () =>
  useResponseParser({
    response: await new Client().try(new Request()),
    schema: responseSchema,
  });

// Using endpoint response.
const { data, status } = await fetchDocument();
if (status === ResponseStatus.API_ERROR) return; // RequestRelatedException<{ document: { name: string; uuid: string; }; } }
if (status === ResponseStatus.ZOD_ERROR) return; // ZodError<{ document: { name: string; uuid: string; } }
new Model(data); // SUCCESS => { document: {  name: string; uuid: string; };
```

## Development
```shell
./cli bootstrap #bootstrap project
./cli yarn install #install dependencies
./cli start #start project
./cli stop #stop project
./cli restart  #restart project
```

---
_Source: https://npm.io/package/@henrotaymcorp/api-client-parser-addon · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
