Class RandomUtils

A utility wrapper for "random" functions.

Please note: These functions are not cryptographically secure, and are considered "pseudo-random".

Constructors

constructor

Properties

boolean color float int item key string value

Constructors

constructor

Properties

Static Readonlyboolean

boolean: () => boolean = randomBoolean

Returns a random boolean value

Type declaration

    • (): boolean

    • Returns boolean

      A random boolean

Static Readonlycolor

color: () => [
    | "Default"
    | "White"
    | "Aqua"
    | "Green"
    | "Blue"
    | "Yellow"
    | "Purple"
    | "LuminousVividPink"
    | "Fuchsia"
    | "Gold"
    | "Orange"
    | "Red"
    | "Grey"
    | "Navy"
    | "DarkAqua"
    | "DarkGreen"
    | "DarkBlue"
    | "DarkPurple"
    | "DarkVividPink"
    | "DarkGold"
    | "DarkOrange"
    | "DarkRed"
    | "DarkGrey"
    | "DarkerGrey"
    | "LightGrey"
    | "DarkNavy"
    | "Blurple"
    | "Greyple"
    | "DarkButNotBlack"
    | "NotQuiteBlack",
    | 0
    | 1146986
    | 1752220
    | 2067276
    | 2123412
    | 2303786
    | 2895667
    | 2899536
    | 3426654
    | 3447003
    | 5763719
    | 5793266
    | 7419530
    | 8359053
    | 9807270
    | 9936031
    | 10038562
    | 10070709
    | 10181046
    | 11027200
    | 11342935
    | 12370112
    | 12745742
    | 15105570
    | 15277667
    | 15418782
    | 15548997
    | 15844367
    | 16705372
    | 16777215,
] = randomColor

Returns a random (discord.js) color as a key-value pair

Type declaration

    • (): [
          | "Default"
          | "White"
          | "Aqua"
          | "Green"
          | "Blue"
          | "Yellow"
          | "Purple"
          | "LuminousVividPink"
          | "Fuchsia"
          | "Gold"
          | "Orange"
          | "Red"
          | "Grey"
          | "Navy"
          | "DarkAqua"
          | "DarkGreen"
          | "DarkBlue"
          | "DarkPurple"
          | "DarkVividPink"
          | "DarkGold"
          | "DarkOrange"
          | "DarkRed"
          | "DarkGrey"
          | "DarkerGrey"
          | "LightGrey"
          | "DarkNavy"
          | "Blurple"
          | "Greyple"
          | "DarkButNotBlack"
          | "NotQuiteBlack",
          | 0
          | 1146986
          | 1752220
          | 2067276
          | 2123412
          | 2303786
          | 2895667
          | 2899536
          | 3426654
          | 3447003
          | 5763719
          | 5793266
          | 7419530
          | 8359053
          | 9807270
          | 9936031
          | 10038562
          | 10070709
          | 10181046
          | 11027200
          | 11342935
          | 12370112
          | 12745742
          | 15105570
          | 15277667
          | 15418782
          | 15548997
          | 15844367
          | 16705372
          | 16777215,
      ]

    • Returns [
          | "Default"
          | "White"
          | "Aqua"
          | "Green"
          | "Blue"
          | "Yellow"
          | "Purple"
          | "LuminousVividPink"
          | "Fuchsia"
          | "Gold"
          | "Orange"
          | "Red"
          | "Grey"
          | "Navy"
          | "DarkAqua"
          | "DarkGreen"
          | "DarkBlue"
          | "DarkPurple"
          | "DarkVividPink"
          | "DarkGold"
          | "DarkOrange"
          | "DarkRed"
          | "DarkGrey"
          | "DarkerGrey"
          | "LightGrey"
          | "DarkNavy"
          | "Blurple"
          | "Greyple"
          | "DarkButNotBlack"
          | "NotQuiteBlack",
          | 0
          | 1146986
          | 1752220
          | 2067276
          | 2123412
          | 2303786
          | 2895667
          | 2899536
          | 3426654
          | 3447003
          | 5763719
          | 5793266
          | 7419530
          | 8359053
          | 9807270
          | 9936031
          | 10038562
          | 10070709
          | 10181046
          | 11027200
          | 11342935
          | 12370112
          | 12745742
          | 15105570
          | 15277667
          | 15418782
          | 15548997
          | 15844367
          | 16705372
          | 16777215,
      ]

      A random color

Static Readonlyfloat

float: (min: number, max: number) => number = randomFloat

Returns a random float between the min and max values

Type declaration

    • (min: number, max: number): number

    • Parameters

      • min: number

        The minimum value

      • max: number

        The maximum value

      Returns number

      A random float

Static Readonlyint

int: (min: number, max: number) => number = randomInt

Returns a random integer between the min and max values

Type declaration

    • (min: number, max: number): number

    • Parameters

      • min: number

        The minimum value

      • max: number

        The maximum value

      Returns number

      A random integer

Static Readonlyitem

item: <T>(items: T[]) => undefined | T = randomItem

Picks a random item from an array

Type declaration

    • <T>(items: T[]): undefined | T

    • Type Parameters

      • T

      Parameters

      • items: T[]

        The array of items

      Returns undefined | T

      A random item

Static Readonlykey

key: <T>(items: Record<string, T> | T[]) => undefined | string = randomKey

Picks a random key from an object/array

Type declaration

    • <T>(items: Record<string, T> | T[]): undefined | string

    • Type Parameters

      • T

      Parameters

      • items: Record<string, T> | T[]

        The object to pick a key from

      Returns undefined | string

      A random key from the input object

Static Readonlystring

string: (length: number, characters?: string | RandomStringOptions) => string = randomString

Returns a random string

Type declaration

    • (length: number, characters?: string | RandomStringOptions): string

    • Parameters

      • length: number

        The length of the string

      • Optionalcharacters: string | RandomStringOptions

        The characters to use in the string

      Returns string

      A random string

Static Readonlyvalue

value: <T>(items: Record<string, T> | T[]) => undefined | T = randomValue

Picks a random value from an object/array

Type declaration

    • <T>(items: Record<string, T> | T[]): undefined | T

    • Type Parameters

      • T

      Parameters

      • items: Record<string, T> | T[]

        The object to pick a value from

      Returns undefined | T

      A random value from the input object

Settings

Member Visibility

On This Page

Constructors
Properties