KeyStore | KeySAVCore

An object that stores any amount of keys for battle videos and saves and can be used to retrieve them.

Hierarchy

KeyStore

Implemented by

Index

Methods

Methods

getBvKey

getBvKey(stamp: string): Promise<BattleVideoKey>

- Defined in key-store.ts:23
Get a promise for a battle video key for the given stamp if available, undefined otherwise.

Parameters
- stamp: string
  
  The stamp that identifies the battle video
Returns Promise<BattleVideoKey>

A promise for the battle video key, if available

getSaveKey

getSaveKey(stamp: string): Promise<SaveKey>

- Defined in key-store.ts:15
Get a promise for save key for the given stamp if available, undefined otherwise.

Parameters
- stamp: string
  
  The stamp that identifies the save
Returns Promise<SaveKey>

A promise for the save key, if available

persistBvKey

persistBvKey(key: BattleVideoKey): Promise<void>

- Defined in key-store.ts:71
Write a key that has already been added to the store to persistent storage.

Parameters
- key: BattleVideoKey
  
  The key to persist
Returns Promise<void>

persistSaveKey

persistSaveKey(key: SaveKey): Promise<void>

- Defined in key-store.ts:64
Write a key that has already been added to the store to persistent storage.

Parameters
- key: SaveKey
  
  The key to persist
Returns Promise<void>

setBvKey

setBvKey(key: BattleVideoKey): Promise<void>

- Defined in key-store.ts:48
Set a battle video key. The returned promise is resolved upon completion.

Parameters
- key: BattleVideoKey
  
  The battle video key to set
Returns Promise<void>

A promise that resolves when the operation is complete

setOrMergeBvKey

setOrMergeBvKey(key: BattleVideoKey): Promise<void>

- Defined in key-store.ts:57
Set a given battle video key if a key for the save is not already available. Otherwise merge the given key with the existing one.

Parameters
- key: BattleVideoKey
  
  The battle video key to set or merge
Returns Promise<void>

A promise that resolves when the operation is complete

setOrMergeSaveKey

setOrMergeSaveKey(key: SaveKey): Promise<void>

- Defined in key-store.ts:40
Set a given save key if a key for the save is not already available. Otherwise merge the given key with the existing one.

Parameters
- key: SaveKey
  
  The save key to set or merge
Returns Promise<void>

A promise that resolves when the operation is complete

setSaveKey

setSaveKey(key: SaveKey): Promise<void>

- Defined in key-store.ts:31
Set a save key. The returned promise is resolved upon completion.

Parameters
- key: SaveKey
  
  The save key to set
Returns Promise<void>

A promise that resolves when the operation is complete

Generated using TypeDoc