https://github.com/ribeirogab/jikan-nodejs

A Node.js wrapper for Jikan REST API.
https://github.com/ribeirogab/jikan-nodejs

anime jikan manga myanimelist nodejs typescript wrapper

Last synced: about 2 months ago
JSON representation

A Node.js wrapper for Jikan REST API.

• Host: GitHub
• URL: https://github.com/ribeirogab/jikan-nodejs
• Owner: ribeirogab
• Created: 2020-06-04T15:56:07.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T18:50:17.000Z (about 2 years ago)
• Last Synced: 2024-11-14T14:53:25.820Z (about 2 months ago)
• Topics: anime, jikan, manga, myanimelist, nodejs, typescript, wrapper
• Language: TypeScript
• Homepage:
• Size: 187 KB
• Stars: 18
• Watchers: 2
• Forks: 5
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        






# Jikan Node.js

> A wrapper for the jikan REST API.

For more information, please refer to [Jikan documentation](https://jikan.docs.apiary.io/#).

## Getting Started 

### Installation

if you use npm

```

$ npm install jikan-nodejs

```

if you use yarn

```

$ yarn add jikan-nodejs

```

### Example

> Feature: genre.animesByGenre(genreId, params)

```js

const { genre } = require('jikan-nodejs');

async function getAnimesByGenre() {

  const animes = await genre.animesByGenre(1, { limit: 10 }); // parameters: genreId, { limit }

  console.log(animes); // print 10 animes of genre 1

}

getAnimesByGenre(); 

```

## Features

- Item By Id;

- Anime:

  - Main Information;

  - Characters & Staff.

- Manga:

  - Main Information;

  - Characters.

- Genre:

  - Anime Listing (All Anime by Genre);

  - Manga Listing (All Anime by Genre).

---

## Contributing

> To get started...

### Step 1

- **Option 1**

    - 🍴  Fork this repo!

- **Option 2**

    - 👯  Clone this repo to your local machine using `git clone https://github.com/ribeirogab/jikan-nodejs.git`

### Step 2

- **HACK AWAY!** 🔨🔨🔨

### Step 3

- 🔃  Create a new pull request using `https://github.com/ribeirogab/jikan-nodejs/compare/`.

---

## Contributors

| [
@lucassodrem1](https://github.com/lucassodrem1) |  |  |  |  |  |

|:-:|:-:|:-:|:-:|:-:|:-:| 

## Author

| [
@ribeirogab](https://github.com/ribeirogab) |

| :---: |

---

## FAQ

- **How do I do *specifically* so and so?**

    - No problem! Just do this.

    

---

## Support

Contact me!

- E-mail `[email protected]`

---

## Licensa

[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://badges.mit-license.org)

- **[MIT license](http://opensource.org/licenses/mit-license.php)**