Module utils

Index

Functions

Functions

Const arrayToKvp

arrayToKvp<T>(array: T[]): Record<string, T>

- Defined in src/utils.ts:54
Helper function to convert an array, to key/value pairs. ie. ['foo', 'bar', 'meow', 'rawr'] => {foo: 'bar', meow: 'rawr'}

function
Type parameters
- T: { toString: any }
Parameters
- array: T[]
Returns Record<string, T>
The object that was converted

Const delay

delay(ms: number): Promise<void>

- Defined in src/utils.ts:14
Helper function to resolve promise after ms.

function
Parameters
- ms: number
  
  Number of milliseconds to delay
Returns Promise<void>
A promise that resovles after ms milliseconds

lazy

lazy<T>(getter: () => undefined | T, updater: () => Promise<void>): Promise<T>

- Defined in src/utils.ts:26
Helper function to provide promises from getters/setters. Used to lazily initialize values when the getter returns undefined.

function
Type parameters
- T
Parameters
- getter: () => undefined | T
  
  A function to return the value
  - - (): undefined | T
    - Returns undefined | T
- updater: () => Promise<void>
  
  A function that sets a value, that can be later retrieved from the getter
  - - (): Promise<void>
    - Returns Promise<void>
Returns Promise<T>
A promise that returns the value that was set from the updater parameter

Const parseAgoString

parseAgoString<T>(value: T): number

- Defined in src/utils.ts:86
Helper function to parse time strings (Mainly on the profile pages) into seconds.
For example: 2m ago => 120

function
throws
{ChatExchangeError} If the string doesn't match the format suffix (s/m/h/d/y).

Type parameters
- T: { toString: any }
Parameters
- value: T
Returns number
The number

Generated using TypeDoc