# jikants

> A wrapper for the jikan REST API.

Latest version **1.2.13** (published 2019-09-13) · MPL-2.0 license · 0 weekly downloads

## Install

```sh
npm install jikants
pnpm add jikants
yarn add jikants
bun add jikants
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.13 |
| Published | 2019-09-13 |
| First published | 2019-04-21 |
| Weekly downloads | 0 |
| License | MPL-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 109.3 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Julien Broyard |
| Maintainers | world_wrecker |
| Keywords | api-wrapper, api, jikan, typescript, wrapper |

## Links

- npm: https://www.npmjs.com/package/jikants
- Repository: https://github.com/Julien-Broyard/jikants
- Homepage: https://github.com/Julien-Broyard/jikants#readme
- Issues: https://github.com/Julien-Broyard/jikants/issues
- npm.io page: https://npm.io/package/jikants

## Dependencies (8)

- [ow](https://npm.io/package/ow.md) ^0.13.2
- [got](https://npm.io/package/got.md) ^9.6.0
- [pino](https://npm.io/package/pino.md) ^5.13.2
- [p-queue](https://npm.io/package/p-queue.md) ^6.1.1
- [prettier](https://npm.io/package/prettier.md) ^1.18.2
- [p-memoize](https://npm.io/package/p-memoize.md) ^3.1.0
- [quick-lru](https://npm.io/package/quick-lru.md) ^4.0.1
- [pino-pretty](https://npm.io/package/pino-pretty.md) ^3.2.1

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.2.13 (latest) — 2019-09-13
- 1.2.11 — 2019-07-28
- 1.2.10 — 2019-07-16
- 1.2.9 — 2019-06-14
- 1.2.8 — 2019-06-08
- 1.2.7 — 2019-06-07
- 1.2.6 — 2019-06-05
- 1.2.5 — 2019-05-28
- 1.2.4 — 2019-05-24
- 1.2.3 — 2019-05-17
- 1.2.2 — 2019-05-15
- 1.2.1 — 2019-05-08
- 1.2.0 — 2019-05-02
- 1.1.2 — 2019-04-29
- 1.1.1 — 2019-04-27
- … 9 more at https://npm.io/package/jikants/versions

## README

<p align="center"><img src="/logo/logotype-horizontal.png"></p>

# jikants

[![Discord Server](https://img.shields.io/discord/460491088004907029.svg?style=flat&logo=discord)](https://discord.gg/4tvCr36)![npm](https://img.shields.io/npm/dm/jikants.svg)[![Netlify Status](https://api.netlify.com/api/v1/badges/369e3e6b-1132-4612-b19a-3090c50cc1a6/deploy-status)](https://app.netlify.com/sites/jikants/deploys)[![Total alerts](https://img.shields.io/lgtm/alerts/g/Julien-Broyard/jikants.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Julien-Broyard/jikants/alerts/)[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/Julien-Broyard/jikants.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Julien-Broyard/jikants/context:javascript)

> A wrapper for the jikan REST API.

## Table of Contents

- [Todo](#todo)
- [Install](#install)
- [Usage](#usage)
- [API](#api)
- [Maintainers](#maintainers)
- [Contributing](#contributing)
- [License](#license)

## Todo

TODO : Improve interfaces
TODO : Add Throttling

## Install

```
$ npm install jikants
$ yarn add jikants
```

## Usage

```js
const JikanTS = require("jikants").default;

/* WITH ES6 */

import JikanTS from "jikants";
```

## API

```js
const JikanTS = require("jikants").default;

/* ANIME */
JikanTS.Anime.byId(1).then(b => console.log(b));
JikanTS.Anime.charactersStaff(1).then(b => console.log(b));
JikanTS.Anime.episodes(1).then(b => console.log(b));
JikanTS.Anime.forum(1).then(b => console.log(b));
JikanTS.Anime.moreInfo(1).then(b => console.log(b));
JikanTS.Anime.news(1).then(b => console.log(b));
JikanTS.Anime.pictures(1).then(b => console.log(b));
JikanTS.Anime.recommendations(1).then(b => console.log(b));
JikanTS.Anime.reviews(1).then(b => console.log(b));
JikanTS.Anime.stats(1).then(b => console.log(b));
JikanTS.Anime.userUpdates(1).then(b => console.log(b));
JikanTS.Anime.videos(1).then(b => console.log(b));

/* CHARACTER */
JikanTS.Character.pictures(1).then(b => console.log(b));

/* CLUB */
JikanTS.Club.info(1).then(b => console.log(b));
JikanTS.Club.members(1).then(b => console.log(b));

/* GENRE */
JikanTS.Genre.anime(1).then(b => console.log(b));
JikanTS.Genre.manga(1).then(b => console.log(b));

/* MAGAZINE */
JikanTS.Magazine.get(1).then(b => console.log(b));

/* MANGA */
JikanTS.Manga.characters(1).then(b => console.log(b));
JikanTS.Manga.forum(1).then(b => console.log(b));
JikanTS.Manga.moreInfo(1).then(b => console.log(b));
JikanTS.Manga.news(1).then(b => console.log(b));
JikanTS.Manga.pictures(1).then(b => console.log(b));
JikanTS.Manga.recommendations(1).then(b => console.log(b));
JikanTS.Manga.reviews(1).then(b => console.log(b));
JikanTS.Manga.stats(1).then(b => console.log(b));
JikanTS.Manga.userUpdates(1).then(b => console.log(b));

/* META */
JikanTS.Meta.requests("anime", "today").then(b => console.log(b));
JikanTS.Meta.status().then(b => console.log(b));

/* PERSON */
JikanTS.Person.pictures(1).then(b => console.log(b));

/* PRODUCER */
JikanTS.Producer.get(1).then(b => console.log(b));

/* SCHEDULE */
JikanTS.Schedule.anime("sunday").then(b => console.log(b));

/* SEARCH */
JikanTS.Search.search("Blue", "anime", 1, { limit: 1 }).then(b =>
  console.log(b)
);

/* SEASON */
JikanTS.Season.anime(2018, "winter").then(b => console.log(b));
JikanTS.Season.archive().then(b => console.log(b));
JikanTS.Season.later().then(b => console.log(b));

/* TOP */
JikanTS.Top.items("anime", 1, "airing").then(b => console.log(b));

/* USER */
JikanTS.User.animeList("myusername", "all", 1).then(b => console.log(b));
JikanTS.User.friends("myusername", 2).then(b => console.log(b));
JikanTS.User.history("myusername", "both").then(b => console.log(b));
JikanTS.User.mangaList("myusername", "all").then(b => console.log(b));
JikanTS.User.profile("myusername").then(b => console.log(b));
```

## Maintainers

[@Julien-Broyard](https://github.com/Julien-Broyard)

Logo by [@Tobaloidee](https://github.com/Tobaloidee)

## Contributing

See [the contributing file](contributing.md)!

PRs accepted.

Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.

## License

MPL-2.0 © 2019 Julien Broyard

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