Skip to content

Latest commit

 

History

History
108 lines (80 loc) · 2.79 KB

README.md

File metadata and controls

108 lines (80 loc) · 2.79 KB

Discloud-API

This is the official NPM Package of Discloud API. Este é o pacote NPM oficial para a API da Discloud.

Contribuintes são bem-vindos. ❤️ Contributors are welcome. ❤️

BUILD NPM_DOWNLOADS NPM_LICENSE NPM_VERSION PULL_REQUESTS

NPM

How to Use

...
const api = new DiscloudAPI('Your Token')

Functions

userStatus()Promise.<(UserStatus|void)>

Get status of user.

get(bot_id)Promise.<(GetBot|void)>

Get data of a bot.

logs(bot_id)Promise.<(BotLogs|void)>

Get log of a bot.

restart(bot_id)Promise.<(BotRestart|void)>

Restart the bot.

userStatus() ⇒ Promise.<(UserStatus|void)>

Get status of user.

Kind: global function Author: GardZock

Example

...
const data = await <(DiscloudAPI)>.userStatus()
//Returns the user data.

get(bot_id) ⇒ Promise.<(GetBot|void)>

Get data of a bot.

Kind: global function Author: GardZock

Param Type Description
bot_id string ID of Bot

Example

...
const bot = await <(DiscloudAPI)>.bot.get('bot id')
//Returns the bot data.

logs(bot_id) ⇒ Promise.<(BotLogs|void)>

Get log of a bot.

Kind: global function Author: GardZock

Param Type Description
bot_id string ID of Bot

Example

...
const logs = await <(DiscloudAPI)>.bot.logs('bot id')
//Returns the logs of bot.

restart(bot_id) ⇒ Promise.<(BotRestart|void)>

Restart the bot.

Kind: global function Author: GardZock

Param Type Description
bot_id string ID of Bot

Example

...
const restart = await <(DiscloudAPI)>.bot.restart('bot id')
//Returns a message if sucess, if not return a error.