Class GCloudDataStore

Hierarchy

Database
- GCloudDataStore

Index

Enumerations

Kinds

Interfaces

Constructors

constructor

Properties

Methods

Object literals

configs

Constructors

constructor

new GCloudDataStore(gcpConfigs: Configs, configs?: DeepPartial<Configs>): GCloudDataStore

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

Properties

datastore

datastore: Datastore

name

name: string = "GCloud Data Store"

type

type: Type = Plugin.Type.DATABASE

Methods

deleteUser

deleteUser(usernameOrID: string): Promise<void>

Overrides Database.deleteUser
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/GCloudDataStore/index.ts#L183
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/GCloudDataStore/index.ts#L53
Parameters
- id: NanoID
Returns Promise<any>

Private getMatchDatastoreKey

getMatchDatastoreKey(matchID: NanoID): Key

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/GCloudDataStore/index.ts#L119
Parameters
- matchID: NanoID
Returns Key

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/GCloudDataStore/index.ts#L58
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/GCloudDataStore/index.ts#L250
Parameters
- tournamentID: NanoID
Returns Promise<{ configs: TournamentConfigsBase; status: Tournament.Status }>

Private getTournamentConfigsDatastoreKey

getTournamentConfigsDatastoreKey(tournamentID: NanoID): Key

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/GCloudDataStore/index.ts#L123
Parameters
- tournamentID: NanoID
Returns Key

getTournamentConfigsModificationDate

getTournamentConfigsModificationDate(tournamentID: NanoID): Promise<Date>

Overrides Database.getTournamentConfigsModificationDate
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/GCloudDataStore/index.ts#L240
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/GCloudDataStore/index.ts#L134
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 getUserDatastoreKey

getUserDatastoreKey(username: string): Key

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/GCloudDataStore/index.ts#L115
Parameters
- username: string
Returns Key

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/GCloudDataStore/index.ts#L200
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/GCloudDataStore/index.ts#L34
Returns Promise<void>

isAdmin

isAdmin(user: PublicUser): boolean

Overrides Database.isAdmin
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/GCloudDataStore/index.ts#L195
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/GCloudDataStore/index.ts#L156
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/GCloudDataStore/index.ts#L218
Parameters
- dimension: Dimension
Returns Promise<void>

registerUser

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

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

storeMatch

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

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

storeTournamentConfigs

storeTournamentConfigs(tournamentID: NanoID, tournamentConfigs: TournamentConfigsBase, status: Tournament.Status): Promise<void>

Overrides Database.storeTournamentConfigs
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/GCloudDataStore/index.ts#L223
Parameters
- tournamentID: NanoID
- tournamentConfigs: TournamentConfigsBase
- status: Tournament.Status
Returns Promise<void>

updateUser

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

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

verifyToken

verifyToken(jwt: string): Promise<any>

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

Object literals

configs

configs: object

Default configs

saveMatches

saveMatches: true = true

saveTournamentMatches

saveTournamentMatches: true = true

Generated using TypeDoc