Options
All
  • Public
  • Public/Protected
  • All
Menu

Class JsonFileStorage

Uses a JSON file to store key/value pairs.

Hierarchy

  • JsonFileStorage

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private Readonly filePath

filePath: string

Private Readonly lockIdentifier

lockIdentifier: ResourceIdentifier

Private Readonly locker

locker: ReadWriteLocker

Methods

delete

  • delete(key: string): Promise<boolean>

entries

  • entries(): AsyncIterableIterator<[string, unknown]>

get

  • get(key: string): Promise<unknown>

Private getJson

  • getJson(): Promise<Dict<unknown>>

Private getJsonSafely

  • getJsonSafely(): Promise<Dict<unknown>>

has

  • has(key: string): Promise<boolean>

set

Private updateJsonSafely

  • updateJsonSafely<T>(updateFn: (json: Dict<unknown>) => T): Promise<T>

  • Updates the data in the JSON file while using a write lock.

    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>

    The return value of updateFn.