BaseDB | Keyvify Documentation

Default structure of the BaseDB. All the database are in this structure and must be.

Hierarchy

EventEmitter
- BaseDB

Implemented by

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BaseDB(options?: EventEmitterOptions): BaseDB

Inherited from BaseDB.constructor
- Defined in node_modules/@types/node/events.d.ts:41
Parameters
- Optional options: EventEmitterOptions
Returns BaseDB

Properties

connected

connected: boolean

Shows if the database is connected

Readonly deserializer

deserializer: (input: string) => any

Deserializer used to deserialize the data

Type declaration

- (input: string): any
- Parameters
  - input: string
  Returns any

Readonly name

name: string

Name of the database

Readonly serializer

serializer: (input: any) => string

Serializer used to serialize the data

Type declaration

- (input: any): string
- Parameters
  - input: any
  Returns string

Readonly type

type: string

Type of the database

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: unique symbol

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

add

add(key: KeyParams, value: any): Promise<Pair>

Adds the value for the specified key

example

await database.add("somekey", 20);
await database.add(["somekey", "hello.world"], 20); // with Dot notations
await database.add("somekey.hello.world", 20); // with Dot notations

Parameters

key: KeyParams

Key for which the data should be added
value: any

Value to be added

Returns Promise<Pair>

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from BaseDB.addListener
- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

all

all(): Promise<Pair[]>

- Defined in src/Managers/Base.ts:224
Fetches everything from database
example
```
await database.all();
```
Returns Promise<Pair[]>

connect

connect(): Promise<void>

- Defined in src/Managers/Base.ts:59
Connects to the database and perform inital tasks
example
```
await database.connect();
```
Returns Promise<void>

delete

delete(key: string): Promise<number>

- Defined in src/Managers/Base.ts:208
Deletes a data pair from the table
example
```
await database.delete();
```
Parameters
- key: string
  
  Key to be deleted
Returns Promise<number>

disconnect

disconnect(): Promise<void>

- Defined in src/Managers/Base.ts:67
Disconnects from the database
example
```
await database.disconnect();
```
Returns Promise<void>

divide

divide(key: KeyParams, value: any): Promise<Pair>

Divides the value for the specified key

example

await database.divide("somekey", 20);
await database.divide(["somekey", "hello.world"], 20); // with Dot notations
await database.divide("somekey.hello.world", 20); // with Dot notations

Parameters

key: KeyParams

Key for which the data should be divided
value: any

Value to be divided

Returns Promise<Pair>

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from BaseDB.emit
- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

empty

empty(): void

- Defined in src/Managers/Base.ts:240
Clears cache
example
```
database.empty();
```
Returns void

entries

entries(): Pair[]

- Defined in src/Managers/Base.ts:232
Gives all cached data (empty if cache is disabled)
example
```
database.entries();
```
Returns Pair[]

eventNames

eventNames(): Array<string | symbol>

Inherited from BaseDB.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns Array<string | symbol>

exponent

exponent(key: KeyParams, value: any): Promise<Pair>

Raises the value according to the value for the specified key

example

await database.exponent("somekey", 20);
await database.exponent(["somekey", "hello.world"], 20); // with Dot notations
await database.exponent("somekey.hello.world", 20); // with Dot notations

Parameters

key: KeyParams

Key for which the data should be raised
value: any

Power

Returns Promise<Pair>

get

get(key: KeyParams): Promise<Pair>

Sets a value for the specified key

example

await database.set("somekey", { hello: { world: true } });
await database.get(["somekey", "hello.world"]); // with Dot notations
await database.get("somekey.hello.world"); // with Dot notations

Parameters

key: KeyParams

Key for which the data should be got

Returns Promise<Pair>

getMaxListeners

getMaxListeners(): number

Inherited from BaseDB.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:69
Returns number

listenerCount

listenerCount(event: string | symbol): number

Inherited from BaseDB.listenerCount
- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from BaseDB.listeners
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

math

math(key: KeyParams, operator: Operators, value: any): Promise<Pair>

- Defined in src/Managers/Base.ts:199
Does math for the specified key
example
```
await database.math("somekey", "+", "hello");
await database.math(["somekey", "hello.world"], "add", 20); // with Dot notations
await database.math("somekey.hello.world", "addition", 20); // with Dot notations
```
Parameters
- key: KeyParams
  
  Key for which the data should be set
- operator: Operators
  
  Math Operator to use used. Refer all operators here: Operators
- value: any
  
  Value
Returns Promise<Pair>

modulo

modulo(key: KeyParams, value: any): Promise<Pair>

- Defined in src/Managers/Base.ts:174
Modulo(s) the value for the specified key
example
```
await database.modulo("somekey", 20);
await database.modulo(["somekey", "hello.world"], 20); // with Dot notations
await database.modulo("somekey.hello.world", 20); // with Dot notations
```
Parameters
- key: KeyParams
  
  Key for which the data should be modulo(ed)
- value: any
  
  Value to be modulo(ed)
Returns Promise<Pair>

multiply

multiply(key: KeyParams, value: any): Promise<Pair>

Multiplies the value for the specified key

example

await database.multiply("somekey", 20);
await database.multiply(["somekey", "hello.world"], 20); // with Dot notations
await database.multiply("somekey.hello.world", 20); // with Dot notations

Parameters

key: KeyParams

Key for which the data should be multiplied
value: any

Value to be multiplied

Returns Promise<Pair>

off

off(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from BaseDB.off
- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string, listener: (...args: any[]) => void): this
on(event: "connect" | "disconnect", listener: () => void): this
on(event: "valueSet" | "valueGet" | "valueUpdate", listener: (pair: Pair) => void): this
on(event: "valueDelete", listener: (key: string, deletedCount: number) => void): this
on(event: "valueFetch", listener: (pairs: Pair[]) => void): this
on(event: "truncate", listener: (deletedCount: number) => void): this

Overrides SQL.on
- Defined in src/Managers/Base.ts:242
Parameters
- event: string
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Overrides SQL.on
- Defined in src/Managers/Base.ts:247
Emitted on connect or disconnected

Parameters
- event: "connect" | "disconnect"
- listener: () => void
  - - (): void
    - Returns void
Returns this
Overrides SQL.on
- Defined in src/Managers/Base.ts:252
Emitted when a value is set, retrieved or updated

Parameters
- event: "valueSet" | "valueGet" | "valueUpdate"
- listener: (pair: Pair) => void
  - - (pair: Pair): void
    - Parameters
      - pair: Pair
      Returns void
Returns this
Overrides SQL.on
- Defined in src/Managers/Base.ts:257
Emitted when a value is updated

Parameters
- event: "valueDelete"
- listener: (key: string, deletedCount: number) => void
  - - (key: string, deletedCount: number): void
    - Parameters
      - key: string
      - deletedCount: number
      Returns void
Returns this
Overrides SQL.on
- Defined in src/Managers/Base.ts:262
Emitted when values are fetched

Parameters
- event: "valueFetch"
- listener: (pairs: Pair[]) => void
  - - (pairs: Pair[]): void
    - Parameters
      - pairs: Pair[]
      Returns void
Returns this
Overrides SQL.on
- Defined in src/Managers/Base.ts:267
Emitted when all values are deleted

Parameters
- event: "truncate"
- listener: (deletedCount: number) => void
  - - (deletedCount: number): void
    - Parameters
      - deletedCount: number
      Returns void
Returns this

once

once(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from BaseDB.once
- Defined in node_modules/@types/node/events.d.ts:64
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from BaseDB.prependListener
- Defined in node_modules/@types/node/events.d.ts:75
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from BaseDB.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

pull

pull(key: KeyParams, value: any): Promise<Pair>

Pulles a value into the array of the specified key

example

await database.pull("somekey", "hello");
await database.pull(["somekey", "hello.world"], "hello"); // with Dot notations
await database.pull("somekey.hello.world", "hello"); // with Dot notations

Parameters

key: KeyParams

Key for which the data should be set
value: any

Value to be set

Returns Promise<Pair>

push

push(key: KeyParams, value: any): Promise<Pair>

Pushes a value into the array of the specified key

example

await database.push("somekey", "hello");
await database.push(["somekey", "hello.world"], "hello"); // with Dot notations
await database.push("somekey.hello.world", "hello"); // with Dot notations

Parameters

key: KeyParams

Key for which the data should be set
value: any

Value to be set

Returns Promise<Pair>

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from BaseDB.rawListeners
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from BaseDB.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from BaseDB.removeListener
- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

set

set(key: KeyParams, value: any): Promise<Pair>

Sets a value for the specified key

example

await database.set("somekey", { hello: { world: true } });
await database.set(["somekey", "hello.world"], false); // with Dot notations
await database.set("somekey.hello.world", false); // with Dot notations

Parameters

key: KeyParams

Key for which the data should be set
value: any

Value to be set

Returns Promise<Pair>

setMaxListeners

setMaxListeners(n: number): this

Inherited from BaseDB.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns this

subtract

subtract(key: KeyParams, value: any): Promise<Pair>

Subtracts the value for the specified key

example

await database.subtract("somekey", 20);
await database.subtract(["somekey", "hello.world"], 20); // with Dot notations
await database.subtract("somekey.hello.world", 20); // with Dot notations

Parameters

key: KeyParams

Key for which the data should be subtracted
value: any

Value to be subtracted

Returns Promise<Pair>

truncate

truncate(): Promise<number>

- Defined in src/Managers/Base.ts:216
Truncates all the data from the table
example
```
await database.truncate();
```
Returns Promise<number>

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from BaseDB.listenerCount
- Defined in node_modules/@types/node/events.d.ts:44
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Hierarchy

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: EventEmitterOptions

Returns BaseDB

Properties

connected

Readonly deserializer

Type declaration

Parameters

input: string

Returns any

Readonly name

Readonly serializer

Type declaration

Parameters

input: any

Returns string

Readonly type

Static defaultMaxListeners

Static Readonly errorMonitor

Methods

add

Parameters

key: KeyParams

value: any

Returns Promise<Pair>

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns this

all

Returns Promise<Pair[]>

connect

Returns Promise<void>

delete

Parameters

key: string

Returns Promise<number>

disconnect

Returns Promise<void>

divide

Parameters

key: KeyParams

value: any

Returns Promise<Pair>

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

empty

Returns void

entries

Returns Pair[]

eventNames

Returns Array<string | symbol>

exponent

Parameters

key: KeyParams

value: any

Returns Promise<Pair>

get

Parameters

key: KeyParams

Returns Promise<Pair>

getMaxListeners

Returns number

listenerCount

Parameters