Class FireStore

Hierarchy

Database
- FireStore

Index

Enumerations

Collections

Interfaces

Constructors

constructor

Properties

Methods

Object literals

configs

Constructors

constructor

new FireStore(fireStoreConfigs: Configs, configs?: DeepPartial<Configs>): FireStore

Overrides Database.constructor
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FireStore/index.ts#L51
Parameters
- fireStoreConfigs: Configs
- Default value configs: DeepPartial<Configs> = {}
Returns FireStore

Properties

db

db: Firestore

matchesCollection

matchesCollection: CollectionReference<MatchCollectionData>

name

name: string = "FireStore"

tournamentConfigsCollection

tournamentConfigsCollection: CollectionReference<TournamentConfigsCollectionData>

type

type: Type = Plugin.Type.DATABASE

userCollection

userCollection: CollectionReference<User>

Methods

connect

connect(): Promise<Firestore>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FireStore/index.ts#L66
Connects to the firestore database and returns the db object

Returns Promise<Firestore>

deleteUser

deleteUser(usernameOrID: string): Promise<void>

Overrides Database.deleteUser
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FireStore/index.ts#L220
Parameters
- usernameOrID: string
Returns Promise<void>

getMatch

getMatch(id: NanoID): Promise<any>

Overrides Database.getMatch
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FireStore/index.ts#L107
Parameters
- id: NanoID
Returns Promise<any>

getPlayerMatches

getPlayerMatches(playerID: nanoid, governID: nanoid, offset?: number, limit?: number, order?: number): Promise<Array<Match>>

Overrides Database.getPlayerMatches
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FireStore/index.ts#L114
Parameters
- playerID: nanoid
- governID: nanoid
- Default value offset: number = 0
- Default value limit: number = 10
- Default value order: number = -1
Returns Promise<Array<Match>>

getTournamentConfigs

getTournamentConfigs(tournamentID: nanoid): Promise<{ configs: TournamentConfigsBase; status: Tournament.Status }>

Overrides Database.getTournamentConfigs
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FireStore/index.ts#L282
Parameters
- tournamentID: nanoid
Returns Promise<{ configs: TournamentConfigsBase; status: Tournament.Status }>

getTournamentConfigsModificationDate

getTournamentConfigsModificationDate(tournamentID: nanoid): Promise<Date>

Overrides Database.getTournamentConfigsModificationDate
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FireStore/index.ts#L271
Parameters
- tournamentID: nanoid
Returns Promise<Date>

getUser

getUser(usernameOrID: string, publicView?: boolean): Promise<User>

Overrides Database.getUser
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FireStore/index.ts#L163
Gets user information. If public is false, will retrieve all information other than password

Parameters
- usernameOrID: string
- Default value publicView: boolean = true
Returns Promise<User>

Private getUserDoc

getUserDoc(usernameOrID: string): Promise<QueryDocumentSnapshot<User>>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FireStore/index.ts#L178
Parameters
- usernameOrID: string
Returns Promise<QueryDocumentSnapshot<User>>

getUsersInTournament

getUsersInTournament(tournamentKey: string, offset?: number, limit?: number): Promise<Array<User>>

Overrides Database.getUsersInTournament
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FireStore/index.ts#L234
Parameters
- tournamentKey: string
- Default value offset: number = 0
- Default value limit: number = -1
Returns Promise<Array<User>>

initialize

initialize(): Promise<void>

Overrides Database.initialize
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FireStore/index.ts#L72
Returns Promise<void>

isAdmin

isAdmin(user: PublicUser): boolean

Overrides Database.isAdmin
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FireStore/index.ts#L229
Parameters
- user: PublicUser
Returns boolean

loginUser

loginUser(username: string, password: string): Promise<string>

Overrides Database.loginUser
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FireStore/index.ts#L193
Parameters
- username: string
- password: string
Returns Promise<string>

manipulate

manipulate(dimension: Dimension): Promise<void>

Overrides Storage.manipulate
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FireStore/index.ts#L253
Parameters
- dimension: Dimension
Returns Promise<void>

registerUser

registerUser(username: string, password: string, userData?: any): Promise<any>

Overrides Database.registerUser
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FireStore/index.ts#L141
Parameters
- username: string
- password: string
- Optional userData: any
Returns Promise<any>

storeMatch

storeMatch(match: Match, governID: nanoid): Promise<any>

Overrides Database.storeMatch
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FireStore/index.ts#L92
Parameters
- match: Match
- governID: nanoid
Returns Promise<any>

storeTournamentConfigs

storeTournamentConfigs(tournamentID: nanoid, tournamentConfigs: TournamentConfigsBase, status: TournamentStatus): Promise<void>

Overrides Database.storeTournamentConfigs
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FireStore/index.ts#L258
Parameters
- tournamentID: nanoid
- tournamentConfigs: TournamentConfigsBase
- status: TournamentStatus
Returns Promise<void>

updateUser

updateUser(usernameOrID: string, update: Partial<User>): Promise<User>

Overrides Database.updateUser
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FireStore/index.ts#L208
Parameters
- usernameOrID: string
- update: Partial<User>
Returns Promise<User>

verifyToken

verifyToken(jwt: string): Promise<string>

Overrides Database.verifyToken
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FireStore/index.ts#L225
Parameters
- jwt: string
Returns Promise<string>

Object literals

configs

configs: object

Default configs

saveMatches

saveMatches: true = true

saveTournamentMatches

saveTournamentMatches: true = true

Generated using TypeDoc