Interface iWelcomeFactService

interface iWelcomeFactService {
    getRandomFact(language: "english" | "french"): Promise<WelcomeFact>;
    getRemoteFactList(): Promise<string[]>;
    saveFactList(list: WelcomeFact[]): Promise<void>;
}

Implemented by

WelcomeFactService

Index

Methods

getRandomFact getRemoteFactList saveFactList

Methods

getRandomFact

getRandomFact(language: "english" | "french"): Promise<WelcomeFact>
Async
Gets a random fact from the WelcomeFact table.
Parameters
- language: "english" | "french"
  the language the fact should be in. Defaults to english !!NOT IMPLEMENTED!!
Returns Promise<WelcomeFact>
a promise containng a 'random' fact

Precondition
the WelcomeFact table must exist

Precondition
A fact must exist in the database.

Throws
FaceQueryError if there is an issue with the WelcomeFaceEntity query.
- Defined in interfaces/iWelcomeFact.ts:46

getRemoteFactList

getRemoteFactList(): Promise<string[]>
Async
Gets the fact list from the remote repo, this list contains string, lines that start with '#', these need to be discarded. (currently only enlish)

Returns Promise<string[]>
A list of string from the remote repo, these need to be parsed to remove comments

Precondition
Connected to the internet

Throws
RemoteFactError there is an issue retrieving the remote fact list
- Defined in interfaces/iWelcomeFact.ts:18

saveFactList

saveFactList(list: WelcomeFact[]): Promise<void>
Async
Wipes the current fact list and saves the new one to the database.

This works because the random fact is retrieved before the table is cleared.
Parameters
- list: WelcomeFact[]
  The list of facts to save into the database
Returns Promise<void>
Precondition
list cannot be empty
- Defined in interfaces/iWelcomeFact.ts:30