swyft-functions
v1.1.3
Published
Install like: ``npm i swyft-functions``
Downloads
2
Readme
Swyft Functions
Install like:
npm i swyft-functions
Define in your project any of the functions in the following way:
const { onlyLetters, time, capitalizeFirst, onlyNumbers, timeformat, random, formatter, percentage, anyMentions, theuser, ifempty, embedError, embedSuccess, embedInfo, embedWarn } = require('swyft-functions');
There is JS-DOC for each function explaining what they are doing.
In short:
onlyLetters(arg);
Returns only letters from an array.
time(array);
Returns time, for example if your array contained "2M 5S", it would return "2m and 5s".
capitalizeFirst(str);
Capitalizes the first letter of the first word in the string.
onlyNumbers(arg);
Returns only numbers from an array
timeformat(array);
Returns time as an object, such as:
{ day: 1, hour: 2, minute: 3, second: 4 }
random(min, max);
Returns random number between min and max values
formatter(countryCode, style, currency);
Returns formatted currency or percentage
percentage(partialValue, totalValue);
Returns the percentage of the total value compared to the partial value
anyMentions(message);
Returns boolean indicating whether the member is mentioned in a discord message
theuser(message, mention);
Returns the user object with properties of id, tag, username, discriminator and avatar
ifempty(string, newline);
Checks whether the value of a string is empty and newline
is used to tell it whether to return a new line after the empty string or not.
It is not a boolean, if a value of variable does not exist, will return an empty string, otherwise will return the string that was passed to the constructor.
embedError(message);
embedSuccess(message);
embedInfo(message);
embedWarn(message);
Return embed objects with proper colors and titles and pass the message property as the embed description method.