Class Storage

Hierarchy

Plugin
- Storage
  - FileSystemStorage
  - GCloudStorage

Index

Enumerations

Type

Interfaces

Configs

Properties

Methods

Properties

configs

configs: Configs

Default configs

Abstract name

name: string

Name of the plugin

Abstract type

type: Type

Type of the plugin. Required in order for Dimensions to know how to use it

Static Database

Database: Database

Static Storage

Storage: Storage

Methods

Abstract download

download(key: string, destination: string, useCached: boolean): Promise<string>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Plugin/Storage/index.ts#L43
Download a file to a destination location. Resolves with path to file. If useCached is true and storage plugin does not need to redownload, destination is ignored

Parameters
- key: string
  
  the key referencing the object to download
- destination: string
  
  destination path to download to locally
- useCached: boolean
  
  if true, storage plugin should avoid downloading file at key if possible. otherwise always redownload
Returns Promise<string>

Abstract getDownloadURL

getDownloadURL(key: string): Promise<string>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Plugin/Storage/index.ts#L53
Get download url (signed url) for a objet with that key

Parameters
- key: string
  
  the key referencing the object to download
Returns Promise<string>

Abstract initialize

initialize(dimension: Dimension): Promise<any>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Plugin/Storage/index.ts#L13
Performs any intialization tasks Resolves when done

Parameters
- dimension: Dimension
Returns Promise<any>

Abstract manipulate

manipulate(dimension: Dimension): Promise<void>

Inherited from Storage.manipulate
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Plugin/index.ts#L24
Manipulates the dimension as necessary for this plugin. Should resolve when done

Parameters
- dimension: Dimension
  
  the dimension the plugin is being applied on
Returns Promise<void>

Abstract upload

upload(file: string, destinationName: string): Promise<string>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Plugin/Storage/index.ts#L32
Upload a file. Resolves with a key to allow for future retrieval

Parameters
- file: string
  
  path tto file to upload
- destinationName: string
  
  destination name
Returns Promise<string>

Abstract uploadTournamentFile

uploadTournamentFile(file: string, user: User, tournament: Tournament): Promise<string>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/Plugin/Storage/index.ts#L21
Upload a file (should be a zip) for a tournament. Returns a identifying key to allow for future retrieval

Parameters
- file: string
  
  path to file to upload
- user: User
- tournament: Tournament
Returns Promise<string>

Generated using TypeDoc