0.1.1 ā€¢ Published 3 years ago

dbd.js-utils v0.1.1

Weekly downloads
428
License
MIT
Repository
-
Last release
3 years ago

dbd.js-utils

An extra Utility that will develop dbd.js bots more easier

What does it do?

  • Formatting Dates
  • Progress Bars for Music and Others
  • ms-parser and parse-ms in one
  • Timeago Possibility
  • Convert to Music Duration Format
  • DBD.JS Command Handling && Reloading
  • Extended JavaScript Map options (Collection)

Methods

  • parseToMS(string) - Convert Duration in String to MS (Same as ms-parser)

Example

.parseToMS("3d10m3M") // can be declared as 3 Months, 3 days, 10 Minutes
  • parseMS(ms) - Convert MS to Durations (seconds, minutes, hours, days, months, years) (More possibilities than parse-ms)

Example

.parseMS(345840000) // 3 and 1 Days, 4 minutes 

Output

{
  second:0,
  minute:4,
  hour:0,
  day:4,
  month:0,
  year:0
}
  • progressBar(SubstractSeconds, maxSeconds, AmountOfBars, addMarker, FilledSymbol, UnfilledSymbol) - Creates a Progress bar based on given data

Logic of command

maxSeconds will be divided by AmountOfBars to create the divider, then SubstractSeconds will subtract maxSeconds and will be divided by divider, the results will create a Filled Bar marked with FilledSymbol, if addMarker is given, it will add it to the end of Filled Bar, then the amount of Filled Bar will substract AmountOfBars to get the Unfilled bars that will be filled with UnfilledSymbol.

Example

.progressBar(102, 315, 10, "šŸ“€", "ā€•", "ā€•")

Output

ā€•ā€•ā€•ā€•šŸ“€ā€•ā€•ā€•ā€•ā€•
  • formatDate(datestamp / date in ms, format, timezone) - Convert datestamp to Date and Format it

Example

.formatDate(1613374163494, "day, dd mmm yyyy", "UTC")

Output

Monday, 15 Feb 2021

List of Formats

FormatDescriptionOutput
YYYYGets the Full Year of date2021
YYGets the last 2 digits of Full Year21
DDDGets the Abbreviation of Day of the WeekMon
DAYGets the Name of Day of the WeekMonday
DDGets the Day Date in Month of date15
DGets the Number Day of the Week2
MMMGets the Month AbbreviationFeb
MONTHGets the Month Name of dateFebruary
MMGets the Month of date2
HOURGets the Amount of Hour of date7
MINGets the Amount of Minutes of date37
SECGets the Amount of Seconds of date37
  • toMusicDuration(ms) - Convert Milliseconds to Music Duration Format (hour:min:sec)

Example

.toMusicDuration(288000)

Output

4:48
  • (class) Collection(Iterable) - Creates an extended Map API with extra methods/functions

Example

const dbdUtil = require("dbd.js-utils")
const Collection = new dbdUtil.Collection()

You can use Object or Array to create a Starting Data (Keys and Values)

new dbdUtil.Collection([["User", "Kino"], ["myId", 123]]) // Array

new dbdUtil.Collection({User:"Kino", myId:123}) // Object
  • (class) CommandHandler() - Creates a class that handles commands

Example

const bot = new dbd.Bot({
  //DBD.JS Options
})
const CommandHandler = new dbdUtil.CommandHandler(bot)
CommandHandler.handle("./commands") // ./commands is a path

Can't see a possibility to reload commands? Wrong, you can!

We added an extra property for you to use the CommandHandler

client.CommandHandler

Reloading commands

$djsEval[

  //Reloading the Commands (path will be automatic if you have used it (Not recommended!))
  client.CommandHandler.handle()
  //with Path
  client.CommandHandler.handle("./commands")
  //or if something went wrong
  client.CommandHandler.handle(`${process.cwd()}/commands`)
]

This can also change bot.loadCommands("./commands") path, which is not needed but for People that don't afford to change all its commands.

//Lets say, you used `bot.loadCommands("./commands")
//but you want to change the path
// to `./myOtherCommands`
// with eval (Example $djsEval)

client.CommandHandler.changeDBDLoadCommandsPath("./myOtherCommands")
  • resolvePath(absolutePath/Path) - Returns a Full version of given Path

Example

//As example if we run the file in `/home/runner/myBotProject`
dbdUtil.resolvePath("./myCommands") // will Return `/home/runner/myBotProject/myCommands`

Something went wrong? Errors? Bugs? Suggestions?

You can join the dbd.js Support Server or Direct Message me in Discord, ID 502968724207304714.

License

See MIT License for License

0.1.1

3 years ago

0.1.0

3 years ago

0.0.10

3 years ago

0.0.9

3 years ago

0.0.8

3 years ago

0.0.8-beta

3 years ago

0.0.7

3 years ago

0.0.7-beta

3 years ago

0.0.5

3 years ago

0.0.6

3 years ago

0.0.4

3 years ago

0.0.2

3 years ago

0.0.1

3 years ago