Class Megdb<V>

Type Parameters

V extends DatabaseSignature<V> = DatabaseMap

Hierarchy

Megdb

Index

Constructors

Properties

cache data driver garbageCollection

Methods

all delete deleteAll filter get pull push runGarbageCollection set setWithTTL snapshot

Constructors

constructor

new Megdb<V>(opt?): Megdb<V>
Creates an instance of Megdb.
Type Parameters
- V extends DatabaseSignature<V> = DatabaseMap
Parameters
- Optional opt: DriverOptions = DefaultDriverOptions
  The options for configuring the database.
Returns Megdb<V>
- Defined in baseDriver.ts:21

Properties

`Private` cache

cache: Record<string, any>

`Private` data

data: Record<string, any>

`Private` driver

driver: JSONDriver<DatabaseMap> | BSONDriver<DatabaseMap> | BINDriver<DatabaseMap>

`Private` garbageCollection

garbageCollection: undefined | GarbageCollectionOptions

Methods

all

all(): Record<string, any>
Retrieves all data from the database.

Returns Record<string, any>
All data from the database.
- Defined in baseDriver.ts:239

delete

delete(path): void
Deletes a value from the database.
Parameters
- path: string
  The path to the value to be deleted.
Returns void
- Defined in baseDriver.ts:156

deleteAll

deleteAll(): void
Deletes all data from the database.

Returns void
- Defined in baseDriver.ts:229

filter

filter<K>(callback): any
Filters the database based on a callback function.
Type Parameters
- K extends string | number | symbol
Parameters
- callback: ((key, value) => any)
  The callback function for filtering.
  - - (key, value): any
    - Parameters
      key: any
      value: V[K]
      Returns any
Returns any
The filtered data.
- Defined in baseDriver.ts:172

get

get<K>(key): any
Retrieves a value from the database.
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
  The key for the value.
Returns any
The retrieved value.
- Defined in baseDriver.ts:110

pull

pull<K>(key, value): void
Removes a value from an array in the database.
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
  The key for the array.
- value: V[K]
  The value to be removed.
Returns void
- Defined in baseDriver.ts:211

push

push<K>(key, value, expirationSeconds?): void
Appends a value to an array in the database.
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
  The key for the array.
- value: V[K]
  The value to be appended.
- Optional expirationSeconds: number
  The expiration time for the array in seconds.
Returns void
- Defined in baseDriver.ts:189

runGarbageCollection

runGarbageCollection(): void
Runs garbage collection to remove expired data.

Returns void
- Defined in baseDriver.ts:247

set

set<K>(key, value, expirationSeconds?): void
Sets a value in the database.
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
  The key for the value.
- value: any
  The value to be stored.
- Optional expirationSeconds: number
  The expiration time for the value in seconds.
Returns void
- Defined in baseDriver.ts:49

setWithTTL

setWithTTL<K>(key, value, ttl, callback?): void
Sets a value in the database with a time-to-live (TTL) expiration.
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
  The key for the value.
- value: V[K]
  The value to be stored.
- ttl: number
  The time-to-live in milliseconds.
- Optional callback: Function
  Callback function to be executed after the TTL expires.
Returns void
- Defined in baseDriver.ts:96

snapshot

snapshot(): Record<string, V>
Creates a snapshot of the current database state.

Returns Record<string, V>
The snapshot of the database.
- Defined in baseDriver.ts:139

Generated using TypeDoc