Class FileSystemStorage

Hierarchy

Storage
- FileSystemStorage

Index

Interfaces

Configs

Constructors

constructor

Properties

Methods

Object literals

configs

Constructors

constructor

new FileSystemStorage(configs?: DeepPartial<Configs>): FileSystemStorage

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FileSystemStorage/index.ts#L26
Parameters
- Optional configs: DeepPartial<Configs>
Returns FileSystemStorage

Properties

_useCacheCount

_useCacheCount: number = 0

bucketPath

bucketPath: string

log

Private lruFileCache

lruFileCache: LRUFileCache

name

name: string = "FS-Storage"

type

type: Type = Plugin.Type.STORAGE

Methods

download

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

Overrides Storage.download
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FileSystemStorage/index.ts#L77
Parameters
- key: string
- destination: string
- useCached: boolean
Returns Promise<string>

getDownloadURL

getDownloadURL(key: string): Promise<string>

Overrides Storage.getDownloadURL
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FileSystemStorage/index.ts#L109
Returns a download URL to use to download an object

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

initialize

initialize(dimension: Dimension): Promise<void>

Overrides Storage.initialize
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FileSystemStorage/index.ts#L40
Initializer. Initializes the storage object and creates necessary buckets

Parameters
- dimension: Dimension
Returns Promise<void>

manipulate

manipulate(dimension: Dimension): Promise<void>

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

upload

upload(file: string, destination?: string): Promise<string>

Overrides Storage.upload
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FileSystemStorage/index.ts#L71
Parameters
- file: string
- Optional destination: string
Returns Promise<string>

uploadTournamentFile

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

Overrides Storage.uploadTournamentFile
- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FileSystemStorage/index.ts#L59
Parameters
- file: string
- user: User
- tournament: Tournament
Returns Promise<string>

writeFileFromBucket

writeFileFromBucket(key: string, dest: string): Promise<void>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FileSystemStorage/index.ts#L54
Parameters
- key: string
- dest: string
Returns Promise<void>

writeFileToBucket

writeFileToBucket(file: string, dest: string): Promise<void>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/SupportedPlugins/FileSystemStorage/index.ts#L50
Parameters
- file: string
- dest: string
Returns Promise<void>

Object literals

configs

configs: object

cacheDir

cacheDir: string = "cache"

loggingLevel

loggingLevel: INFO = Logger.LEVEL.INFO

maxCacheSize

maxCacheSize: number = 1024 * 1024 * 50

Generated using TypeDoc