@roxza/snow.js/README.md

API that provides many features

<br/>
<h1 align="center">Snow.JS Api</h1>
<h6 align="center">Developed with 💙 by Roxza</h6>

---

![npm version](https://badge.fury.io/js/snow.js.svg)
![npm info](https://img.shields.io/npm/dt/snow.js?color=39F4B6)

# 📦 Installation

```console
npm i snow.js --save
yarn add snow.js
```

# 🔮 Importing

```js
import snowApi from "snow.js"; // esm
const snowApi = require("snow.js"); // common
```

# 📝 Usage

```js
snowApi.animal("fox").then((data) => {
  /* 
    supported types;  

    bunny,duck,shiba,fox,dog,cat,kangaroo,raccoon,
    bird,koala,red_panda
  
    {
      status: true,
      name: 'PVFEzQTc.png',
      path: 'images/animals/fox/PVFEzQTc.png',
      url: 'https://cdn.roxza.me/images/animals/fox/PVFEzQTc.png'
    }
  */
});

snowApi.anime("hug").then((data) => {
  /*

    supported types;
    punch,slap,wink,pat,kill,cuddle,waifu,hug,kiss

    {
      status: true,
      name: '1242.gif',
      path: 'images/animes/hug/1242.gif',
      url: 'https://cdn.roxza.me/images/animes/hug/1242.gif'
    }
  */
});

snowApi
  .canvas("lesbian", "https://cdn.roxza.me/images/roxza.png", "./rox.png")
  .then((data) => {
    /*

    supported types;
    lesbian,nonbinary,bisexual,pansexual

    {
        Buffer ...
    }
    */
  });

snowApi.captcha("EASY", "8", "./captcha.png").then((data) => {
  /*
    supported difficulty;
    easy,medium,hard,veryhard

    supported length;
    length must be between 4 and 12.

  {
    status: true,
    data: {
        difficulty: 'EASY',
        length: 8,
        code: 'SGPSUQPW',
        image: {
            url: [Base64]
            buffer: [Object]
        }
    }
  }
  */
});

snowApi.capture("roxza.me", "./screenshot.png").then((data) => {
  /* 
    Type url without using https:// or http:// sample roxza.me
    {
        Buffer..
    }
  */
});

snowApi.covid("world").then((data) => {
  /*
    supported locations;
    turkey,world

  {
    status: true,
    data: {
        rank: 0,
        country: 'WORLD',
        totalCases: 513653934,
        newCases: 114321,
        totalDeaths: 6261885,
        newDeaths: 330,
        totalRecovered: 467892869,
        activeCases: 39499180,
        criticalCase: 40865,
        totalTests: 0
    }
  }
  */
});

snowApi
  .discord("invite", "rabel" /*"user", "939851664389730304"*/)
  .then((data) => {
    /*
    supported types;
    user,invite
    {
        status: true,
        data: [Object]
    }
  */
  });

snowApi.earthquake("turkey").then((data) => {
  /*
    supported locations;
    turkey,world
  */
});

snowApi.memes("1").then((data) => {
  /*
    {
        status: true,
        data: {
            count: 1,
            memes: [ [Object] ]
        }
    }
  */
});

snowApi.randomGif("anime").then((data) => {
  /*
    supported types;
    woman,anime,man

    {
      status: true,
      name: 'TnniwDP4Q.gif',
      path: 'images/anime/TnniwDP4Q.gif',
      url: 'https://cdn.roxza.me/images/anime/TnniwDP4Q.gif'
    }
  */
});

snowApi.csgo("185.193.165.**", "27015").then((data) => {
  /*
    {
    status: true,
    data: {
        game: {
        info: [Object],
        details: [Object],
        players: [Array],
        tags: [Array]
        },
        whois: {
        organization: 'bidibidi',
        iso_code: 'TR',
        location: [Object],
        addr: [Object]
        },
        status: { error: false, message: 'Data fetched successfully' },
        banner_url: null,
        cached: true
    }
    }
  */
});

snowApi
  .overlay(
    "beautiful",
    "https://cdn.roxza.me/images/github.png",
    "./overlay.png"
  )
  .then((data) => {
    /*
    supported types;
      [
        "lisa-presentation",
        "spank",
        "kiss",
        "doublestonk",
        "bed",
        "batslap",
        "blink",
        "blur",
        "gay",
        "greyscale",
        "invert",
        "sepia",
        "triggered",
        "ad",
        "affect",
        "beautiful",
        "bobross",
        "confusedstonk",
        "delete",
        "discord-blue",
        "discord-black",
        "facepalm",
        "hitler",
        "jail",
        "karaba",
        "mms",
        "not-stonk",
        "poutine",
        "rip",
        "stonk",
        "tatoo",
        "thomas",
        "trash",
        "circle",
      ];
        {
            Buffer..
        }
    */
  });
```

---

## 🤝 Contributing

Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/Roxza/snow.js/issues).

## License

Webscreen is **licensed** under the **[MIT License]**. The terms of the license are as follows:

    The MIT License (MIT)

    Copyright (c) 2022 - Roxza

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
    WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
    CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.