Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nekonyadevs/nekonya.js

JavaScript and TypeScript wrapper for NekoNya API.
https://github.com/nekonyadevs/nekonya.js

anime javascript neko nekonya npm package typescript wrapper

Last synced: about 1 month ago
JSON representation

JavaScript and TypeScript wrapper for NekoNya API.

Host: GitHub
URL: https://github.com/nekonyadevs/nekonya.js
Owner: NekoNyaDevs
License: mit
Created: 2022-10-29T12:44:13.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2023-08-20T16:48:42.000Z (over 1 year ago)
Last Synced: 2024-04-24T12:26:47.126Z (8 months ago)
Topics: anime, javascript, neko, nekonya, npm, package, typescript, wrapper
Language: TypeScript
Homepage: https://www.npmjs.com/package/nekonya.js
Size: 13.7 KB
Stars: 3
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # 🌿・NekoNya.js

[![version](https://img.shields.io/npm/v/nekonya.js?style=flat-square)](https://www.npmjs.com/package/nekonya.js)

[![downloads](https://img.shields.io/npm/dt/nekonya.js?style=flat-square)](https://www.npmjs.com/package/nekonya.js)

[![License](https://img.shields.io/github/license/NekoNyaDevs/nekonya.js?style=flat-square)](https://github.com/NekoNyaDevs/nekonya.js/blob/main/LICENSE)

[![Chat](https://img.shields.io/discord/919240056408014910?style=flat-square)](https://discord.gg/trAQZB67)

[![Dependents](https://img.shields.io/librariesio/dependents/npm/nekonya.js?style=flat-square)](https://www.npmjs.com/package/nekonya.js)

NekoNya.js is a NekoNya API wrapper for Node.js.

## ➕・Installation

```bash

npm i nekonya.js

```

## 📝・Usage

```js

const NekoNya = require('nekonya.js');

(async () => {

    const url = await NekoNya.neko();

    console.log(url);

})();

```

## ❓・Documentation

See our [official docs](https://docs.classydev.fr/nekonya.js-docs).

- NekoNya

  - neko() - Returns a random neko image URL.

  - hug() - Returns a random hug image URL.

  - pat() - Returns a random pat image URL.

  - kiss() - Returns a random kiss image URL.

  - kitsune() - Returns a random kitsune image URL.

  - slap() - Returns a random slap image URL.

  - eightball(cute?: boolean) - Returns a random 8ball answer.

  - owoify(text: string) - Returns an owoified text.

  - get(endpoint: string) - Gets an image from the API (raw JSON) with a special endpoint parameter.

## 📜・License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## 📧・Contact

You can contact me on [WorldWild Studios](https://worldwild.studio)'s official [Discord](https://discord.gg/Vh4bnWP5tc), or you can use my [contact email](mailto:[email protected]).

## 👥・Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.