Interface GroupMediaBackend

A generic interface for a group media backend

interface GroupMediaBackend {
    clear(): Promise<void>;
    getItem(key: string): Promise<StoredMedia | null>;
    keys(): Promise<string[]>;
    removeItem(key: string): Promise<void>;
    setItem(key: string, value: StoredMedia): Promise<StoredMedia>;
}

Hierarchy (View Summary)

GenericKeyValueStore<StoredMedia>
- GroupMediaBackend

Index

Utilities

clear getItem keys removeItem setItem

Utilities

clear

clear(): Promise<void>
Clear all items from the store

Returns Promise<void>
Inherited from GenericKeyValueStore.clear
- Defined in ../home/robert/Projects/marmot-ts/src/utils/key-value.ts:14

getItem

getItem(key: string): Promise<StoredMedia | null>
Get an item from the store
Parameters
- key: string
Returns Promise<StoredMedia | null>
Inherited from GenericKeyValueStore.getItem
- Defined in ../home/robert/Projects/marmot-ts/src/utils/key-value.ts:8

keys

keys(): Promise<string[]>
Get all keys in the store

Returns Promise<string[]>
Inherited from GenericKeyValueStore.keys
- Defined in ../home/robert/Projects/marmot-ts/src/utils/key-value.ts:16

removeItem

removeItem(key: string): Promise<void>
Remove an item from the store
Parameters
- key: string
Returns Promise<void>
Inherited from GenericKeyValueStore.removeItem
- Defined in ../home/robert/Projects/marmot-ts/src/utils/key-value.ts:12

setItem

setItem(key: string, value: StoredMedia): Promise<StoredMedia>
Set an item in the store
Parameters
- key: string
- value: StoredMedia
Returns Promise<StoredMedia>
Inherited from GenericKeyValueStore.setItem
- Defined in ../home/robert/Projects/marmot-ts/src/utils/key-value.ts:10

Interface GroupMediaBackend

Hierarchy (View Summary)

Index

Utilities

Utilities

clear

Returns Promise<void>

getItem

Parameters

Returns Promise<StoredMedia | null>

keys

Returns Promise<string[]>

removeItem

Parameters

Returns Promise<void>

setItem

Parameters

Returns Promise<StoredMedia>

Settings

On This Page