Class JsonFileStorage

Uses a JSON file to store key/value pairs.

Hierarchy

JsonFileStorage

Implements

KeyValueStorage<string, unknown>

Index

Constructors

Properties

filePath lockIdentifier locker

Methods

delete entries get getJson getJsonSafely has set updateJsonSafely

Constructors

constructor

new JsonFileStorage(filePath: string, locker: ReadWriteLocker): JsonFileStorage
Parameters
- filePath: string
- locker: ReadWriteLocker
Returns JsonFileStorage
- Defined in src/storage/keyvalue/JsonFileStorage.ts:15

Properties

`Private` `Readonly` filePath

filePath: string

`Private` `Readonly` lockIdentifier

lockIdentifier: ResourceIdentifier

`Private` `Readonly` locker

locker: ReadWriteLocker

Methods

delete

delete(key: string): Promise<boolean>
Deletes the value stored for the given key.

Returns
If there was a value to delete.
Parameters
- key: string
  
  Key to delete.
Returns Promise<boolean>
Implementation of KeyValueStorage.delete
- Defined in src/storage/keyvalue/JsonFileStorage.ts:40

entries

entries(): AsyncIterableIterator<[string, unknown]>
An iterable of entries in the storage.

Returns AsyncIterableIterator<[string, unknown]>
Implementation of KeyValueStorage.entries
- Defined in src/storage/keyvalue/JsonFileStorage.ts:51

get

get(key: string): Promise<unknown>
Returns the value stored for the given identifier. undefined if no value is stored.
Parameters
- key: string
Returns Promise<unknown>
Implementation of KeyValueStorage.get
- Defined in src/storage/keyvalue/JsonFileStorage.ts:23

`Private` getJson

getJson(): Promise<Dict<unknown>>
Reads and parses the data from the JSON file (without locking).

Returns Promise<Dict<unknown>>
- Defined in src/storage/keyvalue/JsonFileStorage.ts:81

`Private` getJsonSafely

getJsonSafely(): Promise<Dict<unknown>>
Acquires the data in the JSON file while using a read lock.

Returns Promise<Dict<unknown>>
- Defined in src/storage/keyvalue/JsonFileStorage.ts:59

has

has(key: string): Promise<boolean>
Checks if there is a value stored for the given key.
Parameters
- key: string
Returns Promise<boolean>
Implementation of KeyValueStorage.has
- Defined in src/storage/keyvalue/JsonFileStorage.ts:28

set

set(key: string, value: unknown): Promise<JsonFileStorage>
Sets the value for the given key.

Returns
The storage.
Parameters
- key: string
  
  Key to set/update.
- value: unknown
  
  Value to store.
Returns Promise<JsonFileStorage>
Implementation of KeyValueStorage.set
- Defined in src/storage/keyvalue/JsonFileStorage.ts:33

`Private` updateJsonSafely

updateJsonSafely<T>(updateFn: ((json: Dict<unknown>) => T)): Promise<T>
Updates the data in the JSON file while using a write lock.

Returns
The return value of updateFn.
Type Parameters
- T
Parameters
- updateFn: ((json: Dict<unknown>) => T)
  
  A function that updates the JSON object.
  - - (json: Dict<unknown>): T
    - Parameters
      
      json: Dict<unknown>
      
      Returns T
Returns Promise<T>
- Defined in src/storage/keyvalue/JsonFileStorage.ts:69