# @habytorg/juro-api

> Typed client API for Juro

Latest version **1.0.6** (published 2023-10-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @habytorg/juro-api
pnpm add @habytorg/juro-api
yarn add @habytorg/juro-api
bun add @habytorg/juro-api
```

## Health

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

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2023-10-20 |
| First published | 2023-10-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 157.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | holcz |
| Maintainers | holczhabytorg |

## Links

- npm: https://www.npmjs.com/package/@habytorg/juro-api
- Repository: https://github.com/habyt/juro-api
- Homepage: https://github.com/habyt/juro-api.git#readme
- Issues: https://github.com/habyt/juro-api.git/issues
- npm.io page: https://npm.io/package/@habytorg/juro-api

## Recent versions

- 1.0.6 (latest) — 2023-10-20
- 1.0.5 — 2023-10-20
- 1.0.4 — 2023-10-20
- 1.0.3 — 2023-10-20
- 1.0.2 — 2023-10-20
- 1.0.1 — 2023-10-20
- 1.0.0 — 2023-10-20

## README

# 📑 Client API for Juro

This client is intended to access [Juro](https://juro.com/) in a type safe manner.
[The API doc description](https://api-docs.juro.com/)


+1: it contains the OpenAPI specification of the Juro API, so you can easily build your own client - if you publish your package with the help of the spec, maybe mention this package as origin. 🍻


## Prerequisites
The package is using the `fetch` API, hence you need to provide it with one of the followings:
- use node version `> 18` - recommended
- use `--experimental-fetch` on node version `>16.15.0`
- install `node-fetch`


## Working with this project

- Install the package: `npm install` / `yarn install`
- Execute the tests: `npm run test` / `yarn test`
- Check linter errors: `npm run lint` / `yarn lint`
- Fix linter errors: `npm run lint:fix`  /`yarn run lint:fix`
- Regenerate the API defs from the open-api specs: `npm run generate` / `yarn generate`

## Examples
```
import { Juro } from '@habyt/juro-api';

const juro = Juro('your-juro-api-key');
const result = await juro.health.healthCheck(); //result is { message: 'ok' }
```

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