Class BINDriver<V>

Type Parameters

V extends DatabaseSignature<V> = DatabaseMap

Hierarchy

BINDriver

Index

Constructors

Properties

MAGIC_NUMBER VERSION backup? filePath timer

Methods

read save savetofile

Constructors

constructor

new BINDriver<V>(opt): BINDriver<V>
Creates an instance of BINDriver.
Type Parameters
- V extends DatabaseSignature<V> = DatabaseMap
Parameters
- opt: BINDriverOptions
  The options for configuring the BIN database driver.
Returns BINDriver<V>
- Defined in providers/BIN.ts:38

Properties

`Private` `Readonly` MAGIC_NUMBER

MAGIC_NUMBER: number = 0xCAFEBABE

Magic number for identifying the file format.

`Private` `Readonly` VERSION

VERSION: number = 1

Version of the BIN file format.

`Private` `Optional` backup

backup?: BackupOptions

`Private` filePath

filePath: string

`Private` timer

timer: null | Timeout

Methods

read

read(): Record<string, string>
Reads data from the BIN file.

Returns Record<string, string>
The read data.
- Defined in providers/BIN.ts:85

save

save(data, cache): void
Saves data to the BIN file with a delayed timer.
Parameters
- data: object
  The data to be saved.
- cache: object
  The cache object.
Returns void
- Defined in providers/BIN.ts:124

savetofile

savetofile(data, cache): void
Saves data to the BIN file immediately.
Parameters
- data: Record<any, any>
  The data to be saved.
- cache: Record<any, any>
  The cache object.
Returns void
- Defined in providers/BIN.ts:139

Generated using TypeDoc