MicroDBBase

The api of the MicroDBBase class.

The MicroDBBase class is the heart of the micro-db package. It manages reading and writing to files.

constructor()

argument	type
options	Partial<MicroDBOptions>

isInitialized

Returns true when the db is initialized.

Type: readonly boolean

fileName

Returns the filename of the db-file.

Type: readonly string

dataSerializer

Returns a reference to the active serializer.

Type: readonly MicroDBSerializer

janitor

Returns a reference to the active janitor instance (if a janitorCronjob got defined in the options).

Type: readonly MicroDBJanitor | undefined

initialize()

Initialize the Database (read in existing data, setup the writeStream, etc.)

The initialization happens automatically before read/write operations when the instance isn't initialized.

Returns: Promise<void>

read()

Get the current dataset of the database.

Returns: Promise<MicroDBData>()

write()

Write a single record into the db file.

argument	type
id	string
data	any

Returns: Promise<void>

writeBatch()

Write multiple records into the file at once.

argument	type
data	MicroDBData

Returns: Promise<void>

deallocate()

Free up memory space by ending the writeStream and removing all stored data from RAM. The Janitor will keep running.

Returns: Promise<void>

close()

Ends the writeStream and kills the janitor (if existing).

Returns: Promise<void>