# canarado-ferret-api

> Simple wrapper for retrieving images from ferret-api.canarado.xyz

Latest version **0.1.9** (published 2023-03-14) · 0 weekly downloads

## Install

```sh
npm install canarado-ferret-api
pnpm add canarado-ferret-api
yarn add canarado-ferret-api
bun add canarado-ferret-api
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.9 |
| Published | 2023-03-14 |
| First published | 2023-03-13 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 4.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | cannywado |

## Links

- npm: https://www.npmjs.com/package/canarado-ferret-api
- npm.io page: https://npm.io/package/canarado-ferret-api

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^1.3.4
- [form-data](https://npm.io/package/form-data.md) ^4.0.0

## Recent versions

- 0.1.9 (latest) — 2023-03-14
- 0.1.8 — 2023-03-14
- 0.1.7 — 2023-03-14
- 0.1.6 — 2023-03-14
- 0.1.5 — 2023-03-14
- 0.1.4 — 2023-03-14
- 0.1.3 — 2023-03-14
- 0.1.2 — 2023-03-14
- 0.1.1 — 2023-03-13
- 0.1.0 — 2023-03-13

## README

# Ferret-API TS Library
This is a very smol library used to communicate with the REST API located at https://ferret-api.canarado.xyz/

## Install
`npm i canarado-ferret-api`

## Usage

Get a random ferret
```ts
import { getRandomFerret } from "canarado-ferret-api";

let data = getRandomFerret();

let cdnUri = data.url; // https://ferret-api.canarado.xyz/cdn/some-uuid-string.<jpg | png>
```

Submit a random ferret: requires an API key, not really a public feature, but is there for completeness
```ts
import { submitFerret, setToken } from "canarado-ferret-api";
import image from "some-image.jpg";

let response = submitFerret(image, "token");

// or

setToken("token");

let response = submitFerret(image);
```

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