jspteroapi/README.md

A pterodactyl v1 api using undici

# JSPteroAPI

[![GitHub](https://img.shields.io/github/license/linux123123/jspteroapi)](https://github.com/Linux123123/JSPteroAPI/blob/main/LICENSE)
![Node.js Package](https://github.com/Linux123123/JSPteroAPI/workflows/Node.js%20Package/badge.svg)
[![GitHub issues](https://img.shields.io/github/issues/linux123123/jspteroapi)](https://github.com/Linux123123/JSPteroAPI/issues)
[![GitHub pull requests](https://img.shields.io/github/issues-pr/linux123123/jspteroapi)](https://github.com/Linux123123/JSPteroAPI/pulls)

[![NPM](https://img.shields.io/badge/npm-CB3837?style=for-the-badge&logo=npm&logoColor=white)](https://npmjs.com/package/jspteroapi)

<h3>A simple Pterodactyl API library using undici <sub><i>(written in typescript)</i></sub></h3>

Uses only 2 dependencies: 
<ul>
<li><img src="https://img.shields.io/github/package-json/dependency-version/linux123123/jspteroapi/undici"/></li>
<li><img src="https://img.shields.io/github/package-json/dependency-version/linux123123/jspteroapi/ws"/></li>
</ul>
    
# To install:

<h5>Install from the command line:</h5>

**Npm**

`npm install jspteroapi`

**Yarn**

`yarn add jspteroapi`

Then include it in your application:

```javascript
const node = require('jspteroapi');
const application = new node.Application('HOST', 'TOKEN'); // for application API
const client = new node.Client('HOST', 'TOKEN'); // for Client API
```

# How to use

You can use any application funtion you want:

```javascript
application.function(parameters).then((response) => {
  // response
});
```

or using async / await

```javascript
const res = await application.function(parameters);
```

# Documentation

<h3><a href="https://jspteroapi.linux123123.com/classes/index.Application.html">Application</a></h3>
<h3><a href="https://jspteroapi.linux123123.com/classes/index.Client.html">Client</a></h3>

# Versions

**How versions work:**

- Panel major version
- The second number is the function release.
- The third number is the bug fix release.

# Disclaimer

I am not responsible for any damages that you cause to your servers/nodes by using **this API**.

**Remember: This API can potentially be dangerous with the ability to Delete Servers/Nodes at an instant!**

# Contributors

Created and maintained by [Linux123123](https://github.com/linux123123)