SWEETY.JS

A helper package for discord bots, easy to use

Classes

Cooldown

const Cooldown = require('sweety.js').Cooldown;

let cooldown = new Cooldown(userId, commandName, timeout);

Parameters (userId, commandName, timeout)

userId(string/integer) = Discord user id,

commandName(string) = Current command name,

timeout(integer) = timeout

METHODS

Cooldown#start()

Start cooldown

cooldown.start();

Cooldown#check()

Check if cooldown is pending or not

if (cooldown.check()) {
	// cooldown is going on 
} else {
	// cooldown ended
}

Cooldown#time(long)

Parameters (long)

long(boolean) = Discord user id (optional)

Time remaining in cooldown to end

cooldown.time(); // 1m
cooldown.time(true); // 1 minute

SweetyDB

const SweetyDB = require('sweety.js').SweetyDB;

let db = new SweetyDB(fileName, directory);

Parameters (fileName, directory)

fileName(string) = Json filename where data will be stored,

directory(string) = Directory where json file will be created

METHODS

SweetyDB#set(property, value)

Parameters (property, value)

property = Property name to save in database value = Value to save in database for property

Set a property value in database

db.set('money', 200); 

SweetyDB#get(property)

Parameters (property)

property = Property name saved in database

Get property value from database

db.get('money'); // 200

SweetyDB#remove(property)

Parameters (property)

property = Property to remove from database

Removes a property and its value from database

db.remove('name');

FirebaseDB

const FirebaseDB = require('sweety.js').FirebaseDB;

let db = new FirebaseDB(config);

Parameters (config)

config(object) = Firebase Configuration example

let db = new FirebaseDB{
    apiKey: "your-api-key",
    authDomain: "your-auth-domain",
    databaseURL: "your-database-url",
    projectId: "your-project-id",
    storageBucket: "your-storage-bucket",
    appId: "your-app-id"
  });

METHODS

FirebaseDB#init()

Initializes database

db.init();

NOTE : Without this firebase database other methods will not work

FirebaseDB#set(property, value)

Parameters (property, value)

property = Property name to save in firebase database value = Value to save in firebase database for property

Set a property value in firebase database

db.set('user.1', {
	name: 'Dev anand',
	age: null,
	work: 'Developer'
}); 

FirebaseDB#get(property)

Parameters (property)

property = Property name saved in firebase database

Get property value from firebase database

db.get('user.1').then((snapshot) => () {
	snapshot.val() // { name: 'Dev anand', age: null, work: 'Developer' }
}); 

If not found returns null

FirebaseDB#remove(property)

Parameters (property)

property = Property to remove from firebase database

Removes a property and its value from firebase database

db.remove('users.1.work'); // Will remove work property  'Dev Anand' user

FUNCTIONS

Utility

toMs(string)

Converts string time to milliseconds

const Utility = require('sweety.js').Utility

Utility.toMs('1h 3m'); // 3780000

Utility.toMs('1hour 3m'); // 3780000