@skyhelperbot/utils

Index

Classes

• GameWinnerCard
• LeaderboardCard
• ShardsUtil
• SkytimesUtils

Functions

• container
• file
• mediaGallery
• mediaGalleryItem
• parseDateFormat
• parsePerms
• postToHaste
• recursiveReadDir
• resolveColor
• row
• section
• separator
• shardsTimeline
• textDisplay
• thumbnail

Interfaces

• ActiveTimes
• Background
• BaseTimes
• EventData
• EventDetails
• LeaderboardOptions
• NotActiveTimes
• ShardInfo
• ShardsCountdown
• SkyEvent
• SpecialEventData
• TSData
• TimelineType
• colorsType
• userData

Type Aliases

• ColorResolvable
• EventKey
• Permission
• ShardsInfo
• TimelineReturnType
• Times

Variables

• eventData
• shardConfig
• shardsInfo

Type Aliases

ColorResolvable

ColorResolvable: keyof typeof Colors | Random | Default | `#${string}` | number | number[]

Can be a number, hex string, an RGB array like:

[255, 0, 255] // purple

or one of the following strings:

• 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
• Random

EventKey

EventKey: geyser | grandma | turtle | daily-reset | eden | aurora | dream-skater | passage-quests | nest-sunset | fireworks-festival | fairy-ring | brook-rainbow

Permission

Permission: keyof typeof permissions

ShardsInfo

ShardsInfo: Record<string, Record<string, ShardInfo>>

TimelineReturnType

TimelineReturnType: Record<typeof shardSequence[number], [TimelineType, TimelineType, TimelineType]>

Times

Times: ActiveTimes | NotActiveTimes

Variables

consteventData

eventData: Record<EventKey, EventData> = ...

constshardConfig

shardConfig: { A: { colors: string; type: string; weekdays: number[] }; B: { colors: string; type: string; weekdays: number[] }; C: { colors: string; type: string; weekdays: number[] }; a: { colors: string; type: string; weekdays: number[] }; b: { colors: string; type: string; weekdays: number[] } } = ...

Type declaration

• A: { colors: string; type: string; weekdays: number[] }

  • colors: string

  • type: string

  • weekdays: number[]

• B: { colors: string; type: string; weekdays: number[] }

  • colors: string

  • type: string

  • weekdays: number[]

• C: { colors: string; type: string; weekdays: number[] }

  • colors: string

  • type: string

  • weekdays: number[]

• a: { colors: string; type: string; weekdays: number[] }

  • colors: string

  • type: string

  • weekdays: number[]

• b: { colors: string; type: string; weekdays: number[] }

  • colors: string

  • type: string

  • weekdays: number[]

constshardsInfo

shardsInfo: ShardsInfo = ...

Returns the shard information for each area

@example

const info = shardsInfo[currentRealm][currentShard]