Interface iWelcomeFactController

interface iWelcomeFactController {
getFact(rerun: boolean): Promise<{ fact: string; rerun: boolean }>;
updateFactList(): Promise<number>;
}

Implemented by

WelcomeFactController

Index

Methods

getFact updateFactList

Methods

getFact

getFact(rerun: boolean): Promise<{ fact: string; rerun: boolean }>
Async
Gets a fact from the database using the current language.

If no fact is retrieved a standard message is sent as well as a flag to tell the hook to rerun the function.
Parameters
- rerun: boolean
  if the function failed to give good results the first time
Returns Promise<{ fact: string; rerun: boolean }>
An object containing the fact and whether the function should run again. The second run is only needed on the first
- Defined in interfaces/iWelcomeFact.ts:73

updateFactList

updateFactList(): Promise<number>
Async
Gets and parses the remote fact list, then updates the local fact list.

Returns Promise<number>
the number of facts

Precondition
Requires an internet connection
- Defined in interfaces/iWelcomeFact.ts:60