ShardsUtil

shardsUtil

@classdesc

A class to handle shards and realms indexing.

Index

Constructors

• constructor

Methods

• getDate
• getNextShard
• getNextShardFromNow
• getShard
• getShardsBetween
• getStatus
• getSuffix
• shardsIndex

Constructors

constructor

• new ShardsUtil(): ShardsUtil

• Returns ShardsUtil

Methods

staticgetDate

• getDate(date?: null | string): string | DateTime<boolean>

• @method

  getDate - get provided date in luxon

  ---

  Parameters

  Name	Type	Default	Description
  optionaldate	null | string		date to get in moment

  Returns string | DateTime<boolean>

staticgetNextShard

• getNextShard(date: DateTime<boolean>, shardType?: (black | red)[]): null | { duration: string; end: DateTime<boolean>; index: number; info: ShardInfo; start: DateTime<boolean> }

• Get the next occuring black/red shard timing for the given date;

  ---

  Parameters

  Name	Type	Default	Description
  date	DateTime<boolean>
  optionalshardType	(black | red)[]		The type of shard to get the next occuring shard for

  Returns null | { duration: string; end: DateTime<boolean>; index: number; info: ShardInfo; start: DateTime<boolean> }

  the shard details or null if no shard is found

staticgetNextShardFromNow

• getNextShardFromNow(shardType?: (black | red)[]): { duration: string; end: DateTime<boolean>; index: number; info: ShardInfo; start: DateTime<boolean> }

• Get the next occuring shard timing from today

  ---

  Parameters

  Name	Type	Default	Description
  optionalshardType	(black | red)[]		The type of shard to get the next occuring shard for

  Returns { duration: string; end: DateTime<boolean>; index: number; info: ShardInfo; start: DateTime<boolean> }

  an upcoming shard relative from now

  • duration: string

  • end: DateTime<boolean>

  • index: number

  • info: ShardInfo

  • start: DateTime<boolean>

staticgetShard

• getShard(date: DateTime<boolean>): null | { info: ShardInfo; timings: [TimelineType, TimelineType, TimelineType] }

• Parameters

  Name	Type	Default	Description
  date	DateTime<boolean>

  Returns null | { info: ShardInfo; timings: [TimelineType, TimelineType, TimelineType] }

staticgetShardsBetween

• getShardsBetween(start?: DateTime<true> | DateTime<false>, end: DateTime<boolean>): { date: DateTime<boolean>; shard: null | { duration: string; end: DateTime<boolean>; index: number; info: ShardInfo; start: DateTime<boolean> } }[]

• Get shards between given range

  ---

  Parameters

  Name	Type	Default	Description
  start	DateTime<true> | DateTime<false>	= ...
  end	DateTime<boolean>

  Returns { date: DateTime<boolean>; shard: null | { duration: string; end: DateTime<boolean>; index: number; info: ShardInfo; start: DateTime<boolean> } }[]

staticgetStatus

• getStatus(date: DateTime<boolean>): ShardsCountdown[] | No Shard

• Get all three shards status for a given date relative to the current time

  ---

  Parameters

  Name	Type	Default	Description
  date	DateTime<boolean>		The date for which to get the status for

  Returns ShardsCountdown[] | No Shard

staticgetSuffix

• getSuffix(number: number): string

• Returns suffix for a given number

  ---

  Parameters

  Name	Type	Default	Description
  number	number		The number to get the suffix for

  Returns string

staticshardsIndex

• shardsIndex(date: DateTime<boolean>): { currentRealm: prairie | forest | valley | wasteland | vault; currentShard: C | b | A | a | B }

• Returns shards index for a given date

  ---

  Parameters

  Name	Type	Default	Description
  date	DateTime<boolean>

  Returns { currentRealm: prairie | forest | valley | wasteland | vault; currentShard: C | b | A | a | B }

  • currentRealm: prairie | forest | valley | wasteland | vault

  • currentShard: C | b | A | a | B