# mycenter-npm

> myCenter API wrapper for Node.JS users.

Latest version **1.0.3** (published 2021-07-19) · ISC license · 0 weekly downloads

## Install

```sh
npm install mycenter-npm
pnpm add mycenter-npm
yarn add mycenter-npm
bun add mycenter-npm
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2021-07-19 |
| First published | 2021-07-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | nickanda |

## Links

- npm: https://www.npmjs.com/package/mycenter-npm
- Repository: https://github.com/myCenter-Roblox/mycenter-npm
- Homepage: https://github.com/myCenter-Roblox/mycenter-npm#readme
- Issues: https://github.com/myCenter-Roblox/mycenter-npm/issues
- npm.io page: https://npm.io/package/mycenter-npm

## Dependencies (1)

- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.1

## Recent versions

- 1.0.3 (latest) — 2021-07-19
- 1.0.2 — 2021-07-19
- 1.0.1 — 2021-07-19
- 1.0.0 — 2021-07-19

## README

# mycenter-npm
myCenter API wrapper for Node.JS users.

# Installation
Install by running the `npm install --save mycenter-npm` command.

# Usage

This will be the most simple form of documentation that you will  ever see in an NPM package. If you aren't familiar with Node.JS, **steer clear away from here**.

```js
// Intiilization
const myCenter = require('mycenter-npm');
const GroupBot = new myCenter("mcv5_group_bot:many-other-letters-and-numbers");

// Functions

// GroupBot.shout(Message)
// Message - String
// Returns: Promise<{
//   success: bool,
//   ?disclaimer: string,
//   ?reason: string
// }>
GroupBot.shout("This is an example shout");

// GroupBot.exile(UserId)
// UserId - Number
// Returns: Promise<{
//   success: bool,
//   ?disclaimer: string,
//   ?reason: string
// }>
GroupBot.exile(123456);

// GroupBot.rank(UserId, RankId)
// UserId - Number
// RankId - Number [1-255]
// Returns: Promise<{
//   success: bool,
//   ?disclaimer: string,
//   ?reason: string
// }>
GroupBot.rank(123456, 200);

// GroupBot.getJoinRequests()
// Returns: Promise<{
//   success: bool,
//   data: JSON,
// }>
GroupBot.getJoinRequests();

// GroupBot.acceptJoinRequest(UserId)
// UserId - Number
// Returns: Promise<{
//   success: bool,
//   ?disclaimer: string,
//   ?reason: string
// }>
GroupBot.acceptJoinRequest(123456);

// GroupBot.declineJoinRequest(UserId)
// UserId - Number
// Returns: Promise<{
//   success: bool,
//   ?disclaimer: string,
//   ?reason: string
// }>
GroupBot.declineJoinRequest(123456);
```

If there are any bugs, please feel free to post a bug report on the Github.

---
_Source: https://npm.io/package/mycenter-npm · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._