https://github.com/th3shadowbroker/spigotmc.js

A wrapper for the Spigot API
https://github.com/th3shadowbroker/spigotmc.js

Last synced: about 1 month ago
JSON representation

A wrapper for the Spigot API

• Host: GitHub
• URL: https://github.com/th3shadowbroker/spigotmc.js
• Owner: Th3Shadowbroker
• License: mit
• Created: 2021-12-21T22:19:17.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-28T00:09:56.000Z (about 2 months ago)
• Last Synced: 2024-09-28T12:03:39.687Z (about 2 months ago)
• Language: TypeScript
• Size: 1.22 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# SpigotMC.js

![](https://img.shields.io/github/issues/Th3Shadowbroker/spigotmc.js)

![](https://img.shields.io/github/forks/Th3Shadowbroker/spigotmc.js)

![](https://img.shields.io/github/stars/Th3Shadowbroker/spigotmc.js)

![](https://img.shields.io/github/license/Th3Shadowbroker/spigotmc.js)

SpigotMC.js is an API wrapper for the [XenforoResourceManageAPI](https://github.com/SpigotMC/XenforoResourceManagerAPI). This project is fully open-source.

**Using SpigotMC.js in your project**

`npm install @th3shadowbroker/spigotmc.js` or `yarn add @th3shadowbroker/spigotmc.js`

## Dependencies

**Axios**: This library uses the popular Axios REST client to perform requests to the Spigot API.

## Documentation

A full documentation can be found on [GitHub Pages](https://th3shadowbroker.github.io/spigotmc.js/).

## Usage

```typescript

import { Spigot } from '@th3shadowbroker/spigotmc.js';

new Spigot().findAuthor("th3shadowbroker")

    .then(author => {

        if (author) {

            console.log(`The authors id is ${author.id}!`);

        } else {

            console.error("Author not found!");

        }

    })

    .catch(error => {

        console.error(error);

    });

```