common/docs/db/classes/_fileflatdb_index_.fileflatdb.md

Hierarchy

↳ Impl

↳ FileFlatDb

Implements

• BaseDb

Constructors

constructor

⊕ new FileFlatDb(base: string, file?: string, options?: BaseDbOptions): FileFlatDb

Overrides Cache.constructor

Defined in FileFlatDb/index.ts:18

Parameters:

Name	Type	Default value
base	string	-
Default value file	string	defaults.DEFAULT_FILE
Default value options	BaseDbOptions	{}

Returns: FileFlatDb

---

Methods

close

▸ close(): void

Implementation of BaseDb.close

Defined in FileFlatDb/index.ts:31

Returns: void

---

del

▸ del(key: Uint8Array): void

Implementation of BaseDb.del

Defined in FileFlatDb/index.ts:74

Parameters:

Name	Type
key	Uint8Array

Returns: void

---

drop

▸ drop(): void

Implementation of BaseDb.drop

Defined in FileFlatDb/index.ts:39

Returns: void

---

empty

▸ empty(): void

Implementation of BaseDb.empty

Defined in FileFlatDb/index.ts:45

Returns: void

---

get

▸ get(key: Uint8Array): Uint8Array | null

Implementation of BaseDb.get

Defined in FileFlatDb/index.ts:78

Parameters:

Name	Type
key	Uint8Array

Returns: Uint8Array | null

---

maintain

▸ maintain(fn: ProgressCb): void

Implementation of BaseDb.maintain

Defined in FileFlatDb/index.ts:66

Parameters:

Name	Type
fn	ProgressCb

Returns: void

---

open

▸ open(): void

Implementation of BaseDb.open

Defined in FileFlatDb/index.ts:23

Returns: void

---

put

▸ put(key: Uint8Array, value: Uint8Array): void

Implementation of BaseDb.put

Defined in FileFlatDb/index.ts:96

Parameters:

Name	Type
key	Uint8Array
value	Uint8Array

Returns: void

---

rename

▸ rename(base: string, file: string): void

Implementation of BaseDb.rename

Defined in FileFlatDb/index.ts:55

Parameters:

Name	Type
base	string
file	string

Returns: void

---

size

▸ size(): number

Implementation of BaseDb.size

Defined in FileFlatDb/index.ts:51

Returns: number

---