Global

currentEnv() → {CurrEnvValues}

Returns the current environment.

Source:

currentEnv.ts, line 15

Returns:

Type:: CurrEnvValues

The current environment.

(async) flattenMarkdown(string, guild) → {Promise.<string>}

Source:

flattenMarkdown.ts, line 9

Parameters:

Name	Type	Description
`string`	`string`	The string to flatten markdown
`guild`	`Discord.Guild`	The Discord guild to fetch property managers from

Returns:

Type:: Promise.<string>

The flattened markdown string

formatPunishmentTime(length, bareopt) → {string}

Formats a punishment time to a human readable format

Source:

formatPunishmentTime.ts, line 9

Parameters:

Name	Type	Attributes	Description
`length`	`number`		the length of the punishment
`bare`	`boolean`	<optional>	false by default, whether to return the time in a bare format (without suffix)

Returns:

Type:: string

The formatted punishment time

formatTimestamp(date, format)

Source:

formatTimestamp.ts, line 14

Parameters:

Name Type Description

Name	Type	Description
`date`	`Date` \| `number`	The date to format, can be a number in milliseconds or a Date object
`format`	`"d"` \| `"D"` \| `"f"` \| `"F"` \| `"R"` \| `"t"` \| `"T"`	"f" by default, see below for more info Available formats: `d` (01/01/1970) `D` (January 1, 1970) `f` (January 1, 1970 12:00 AM) `F` (Thursday, January 1, 1970 12:00 AM) `R` (51 years ago) `t` (12:00 AM) `T` (9:00:00 PM)

date

Date | number

The date to format, can be a number in milliseconds or a Date object

format

"d" | "D" | "f" | "F" | "R" | "t" | "T"

"f" by default, see below for more info Available formats:

d (01/01/1970)
D (January 1, 1970)
f (January 1, 1970 12:00 AM)
F (Thursday, January 1, 1970 12:00 AM)
R (51 years ago)
t (12:00 AM)
T (9:00:00 PM)

hexToNum(hexCode) → {number}

Converts a hex color to base-10

Source:

hexToNum.ts, line 8

Parameters:

Name	Type	Description
`hexCode`	`string`	the hex code to convert

Returns:

Type:: number

The hex value in base-10

hexToRGB(hexCode) → {Array.<number>}

Converts a hex color to rgb

Source:

hexToRGB.ts, line 8

Parameters:

Name	Type	Description
`hexCode`	`string`	the hex code to convert

Returns:

Type:: Array.<number>

The RGB values of the hex code, lenght 3

humanizeArray(array, codeopt, conjunctionopt, commaopt) → {string}

Make an array human readable

Source:

humanizeArray.ts, line 10

Parameters:

Name	Type	Attributes	Description
`array`	`Array.<unknown>`		The array to humanize
`code`	`boolean`	<optional>	Whether to return the in code blocks, true by default
`conjunction`	`string`	<optional>	The conjunction to use for the final list element, "and" by default
`comma`	`string`	<optional>	The comma to use for the element seperation, "," by default

Returns:

Type:: string

The humainized array

humanizeConstant(name, uppercaseExceptionsopt, lowercaseExceptionsopt) → {string}

Make a constant human readable

Source:

humanizeConstant.ts, line 9

Parameters:

Name	Type	Attributes	Description
`name`	`string`		The constant to humainize
`uppercaseExceptions`	`string`	<optional>	Optional, a list of words to uppercase as is
`lowercaseExceptions`	`string`	<optional>	Optional, a list of words to lowercase as is

Returns:

Type:: string

The humainized constant

isURL(input) → {boolean}

Check if a string is a valid URL

Source:

isUrl.ts, line 8

Parameters:

Name	Type	Description
`input`	`string`	The input to check

Returns:

Type:: boolean

whether the input is a valid URL

(async) loadDir(dir, processopt, baseCollectionopt) → {Promise.<Discord.Collection.<string, T>>}

Loads a directory of files and returns an collection of the files code contents

Source:

loadDir.ts, line 16

Parameters:

Name	Type	Attributes	Description
`dir`	`string`		The directory to load
`process`	`function`	<optional>	The function to process each file
`baseCollection`	`Discord.Collection.<string, T>`	<optional>	The base collection to add the files to

Returns:

Type:: Promise.<Discord.Collection.<string, T>>

The collection of files This is a generic loadDir, the one in main bot supercedes it For main bot use, use the one in main bot

(async) loadJSON5(filename) → {Promise.<any>}

Loads a json5 file asyncronously

Source:

loadJSON5.ts, line 11

Parameters:

Name	Type	Description
`filename`	`string`	The file to load

Returns:

Type:: Promise.<any>

The loaded file

loadSyncJSON5(filename) → {any}

Loads a json5 file syncronously

Source:

loadJSON5.ts, line 27

Parameters:

Name	Type	Description
`filename`	`string`	The file to load

Returns:

Type:: any

The loaded file

noop(…_unused) → {null}

A no-operation function

Source:

noop.ts, line 9

Parameters:

Name	Type	Attributes	Description
`_unused`	`Array.<unknown>`	<repeatable>	This parameter is not used, it is a NO-OP function

Returns:

Type:: null

Always returns null

pastTense(verb) → {string}

Inflects a verb into past tense

Source:

pastTense.ts, line 9

Parameters:

Name	Type	Description
`verb`	`string`	The verb to inflict in past tense

Returns:

Type:: string

The verb in past tense

pluralize(word, countopt, inclusiveopt) → {string}

Pluralize or singularize a word based on the passed in count.

Source:

pluralize.ts, line 113

Parameters:

Name	Type	Attributes	Description
`word`	`string`		The word to change the plural of
`count`	`number`	<optional>	How many objects are we talking about?, optional
`inclusive`	`boolean`	<optional>	Whether to include the number in the pluralized word, optional

Returns:

Type:: string

The pluralized word

quote(text) → {string}

Quote a text in markdown

Source:

quote.ts, line 7

Parameters:

Name	Type	Description
`text`	`string`	The text to quote

Returns:

Type:: string

The quoted text

(async) replaceAsync(string, searchValue, replacer) → {Promise.<string>}

Replaces a string with a value asynchronously

Source:

replaceAsync.ts, line 10

Parameters:

Name	Type	Description
`string`	`string`	The string to search and replace in
`searchValue`	`string` \| `RegExp`	The value to search for
`replacer`	`function` \| `string`	The function to process each match, or replacement string

Returns:

Type:: Promise.<string>

The replaced string

stringifyAnything(thing, indentopt, depthopt, currentDepthopt) → {string}

Stringifies literally anything

Source:

stringifyAnything.ts, line 11

Parameters:

Name	Type	Attributes	Description
`thing`	`unknown`		The thing to stringify
`indent`	`number`	<optional>	The indent depth, 0 by default
`depth`	`number`	<optional>	The space depth, 0 by default
`currentDepth`	`number`	<optional>	The total depth offset to base other depths off of, 0 by default

Returns:

Type:: string

Your weirdest thing, stringified

trimSides(text, startTrim, endTrim) → {string}

A lodash macro to trim the sides of a string

Source:

trimSides.ts, line 10

Parameters:

Name	Type	Description
`text`	`string`	The text to trim
`startTrim`	`string`	The string to trim from the start
`endTrim`	`string`	The string to trim from the end

Returns:

Type:: string

The trimmed text

truncateString(string, length, ellipsisopt) → {string}

Truncate a string to a certain length

Source:

truncateString.ts, line 9

Parameters:

Name	Type	Attributes	Description
`string`	`string`		The string to truncate
`length`	`number`		The length of the truncated string
`ellipsis`	`string`	<optional>	The ellipsis to use, "..." by default

Returns:

Type:: string

The truncated string

Members

CurrEnvValues

Methods

currentEnv() → {CurrEnvValues}

Returns:

(async) flattenMarkdown(string, guild) → {Promise.<string>}

Parameters:

Returns:

formatPunishmentTime(length, bareopt) → {string}

Parameters:

Returns:

formatTimestamp(date, format)

Parameters:

hexToNum(hexCode) → {number}

Parameters:

Returns:

hexToRGB(hexCode) → {Array.<number>}

Parameters:

Returns:

humanizeArray(array, codeopt, conjunctionopt, commaopt) → {string}

Parameters:

Returns:

humanizeConstant(name, uppercaseExceptionsopt, lowercaseExceptionsopt) → {string}

Parameters:

Returns:

isURL(input) → {boolean}

Parameters:

Returns:

(async) loadDir(dir, processopt, baseCollectionopt) → {Promise.<Discord.Collection.<string, T>>}

Parameters:

Returns:

(async) loadJSON5(filename) → {Promise.<any>}

Parameters:

Returns:

loadSyncJSON5(filename) → {any}

Parameters:

Returns:

noop(…_unused) → {null}

Parameters:

Returns:

pastTense(verb) → {string}

Parameters:

Returns:

pluralize(word, countopt, inclusiveopt) → {string}

Parameters:

Returns:

quote(text) → {string}

Parameters:

Returns:

(async) replaceAsync(string, searchValue, replacer) → {Promise.<string>}

Parameters:

Returns:

stringifyAnything(thing, indentopt, depthopt, currentDepthopt) → {string}

Parameters:

Returns:

trimSides(text, startTrim, endTrim) → {string}

Parameters:

Returns:

truncateString(string, length, ellipsisopt) → {string}

Parameters:

Returns: