Class Database

constructor

• new Database(options?): Database

• Parameters

  • Optional options: DatabaseOptions

  Returns Database

Readonly autoDecrypt

Optional Readonly options

Readonly readyInDate

uptime

• get uptime(): number

• Returns number

  Description

  Returns database connection uptime!

  Example

  console.log(`Database is up for ${db.uptime} ms.`);
  Copy

add

• add(key, value): Promise<undefined | void | ElementValue>

• Parameters

  • key: string

    Data key

  • value: ElementValue

    The value, must be a number

  Returns Promise<undefined | void | ElementValue>

  Example

  <db>.add(`data`,2)
  Copy

all

• all(limit?): Promise<Element[]>

• Parameters

  • limit: number = 0

    default = 0

  Returns Promise<Element[]>

  Description

  Returns all elements in Database

  Example

  <db>.all()
  Copy

clear

• clear(): Promise<void>

• Returns Promise<void>

  Description

  Clean all data

  Example

  <db>.clear()
  Copy

decryptString

• decryptString(value): string | number | void

• Parameters

  • value: string

  Returns string | number | void

delete

• delete(key): Promise<undefined | void | ElementValue>

• Parameters

  • key: any

    Type a key for the element

  Returns Promise<undefined | void | ElementValue>

  Promise

  Description

  delete element from database

  Example

  <db>.delete(`version`)
  Copy

deleteAll

• deleteAll(): Promise<void>

• Returns Promise<void>

  Description

  Delete all data

  Example

  <db>.deleteAll()
  Copy

double

• double(key): Promise<undefined | void | ElementValue>

• Parameters

  • key: string

    Data key

  Returns Promise<undefined | void | ElementValue>

  Example

  <db>.double("coins")
  Copy

encryptString

• encryptString(value?): string

• Parameters

  • value: string = "hi"

  Returns string

endsWith

• endsWith(key): Promise<Element[]>

• Parameters

  • key: string

  Returns Promise<Element[]>

  Description

  Check if the key ends with the key in the database

  Example

  <db>.endsWith({key:`st.db`})
  Copy

fetch

• fetch(key): Promise<void | ElementValue>

• Parameters

  • key: string

    Type a key for the element

  Returns Promise<void | ElementValue>

  Description

  To fetch the value of a specific key element

  Example

  <db>.fetch(`version`)
  Copy

filter

• filter(key, callback): Promise<Element[]>

• Parameters

  • key: string

  • callback: ((element, index, elements) => Element)

    • • (element, index, elements): Element

      • Parameters

        • element: Element

        • index: Number

        • elements: Element[]

        Returns Element

  Returns Promise<Element[]>

  Description

  Filter the database by the key

  Example

  <db>.filter(t => t == "test")
  Copy

get

• get(key): Promise<void | ElementValue>

• Parameters

  • key: string

    Type a key for the element

  Returns Promise<void | ElementValue>

  Boolean

  Description

  To get the value of a specific key element

  Example

  <db>.get(`version`)
  Copy

has

• has(key): Promise<boolean>

• Parameters

  • key: string

    Type a key for the element

  Returns Promise<boolean>

  Description

  Checking an item from the database if it exists or not

  Example

  <db>.has(`version`)
  Copy

includes

• includes(key): Promise<Element[]>

• Parameters

  • key: string

  Returns Promise<Element[]>

  Description

  Check if the key includes with the key in the database

  Example

  <db>.includes({key:`st.db`})
  Copy

isEncryptString

• isEncryptString(value): boolean | void

• Parameters

  • value: any

  Returns boolean | void

keysAll

• keysAll(): Promise<string[]>

• Returns Promise<string[]>

  Example

  <db>.keysAll()
  Copy

math

• math(key, operator?, new_value?): Promise<undefined | void | ElementValue>

• Parameters

  • key: string

    Data key

  • Optional operator: "/" | "-" | "+" | "*"

    One of +, -, %, * or /

  • Optional new_value: string | number

  Returns Promise<undefined | void | ElementValue>

  Description

  Does a math calculation and stores the value in the database!

  Example

  db.math("points","+",150)
  Copy

multiply

• multiply(key, value): Promise<undefined | void | ElementValue>

• Parameters

  • key: string

    Data key

  • value: ElementValue

    The value, must be a number

  Returns Promise<undefined | void | ElementValue>

  Example

  <db>.multiply("coins", 2)
  Copy

pop

• pop(key): Promise<undefined | ElementValue>

• Parameters

  • key: string

  Returns Promise<undefined | ElementValue>

  Description

  Removes the last element of the array

  Example

  <db>.pop(`hello`)
  Copy

pull

• pull(key, value): Promise<undefined | ElementValue>

• Parameters

  • key: string

    Type a key for the element

  • value: ElementValue

  Returns Promise<undefined | ElementValue>

  Description

  To pull an element from an array into data

  Example

  <db>.pull(`version`,"v6")
  Copy

push

• push(key, value): Promise<undefined | ElementValue>

• Parameters

  • key: string

    Type a key for the element

  • value: ElementValue

  Returns Promise<undefined | ElementValue>

  Description

  To push an element to an array into data

  Example

  <db>.push(`version`,"v6")
  Copy

remove

• remove(key): Promise<undefined | void | ElementValue>

• Parameters

  • key: any

    Type a key for the element

  Returns Promise<undefined | void | ElementValue>

  Description

  delete element from database

  Example

  <db>.delete(`version`})
  Copy

set

• set(key, value): Promise<undefined | ElementValue>

• Parameters

  • key: string

    Type a key for the element

  • value: ElementValue

    Type a value for the element

  Returns Promise<undefined | ElementValue>

  Description

  set element in database

  Example

  <db>.set({key:`version`,value:"v6"})
  Copy

shift

• shift(key): Promise<undefined | ElementValue>

• Parameters

  • key: string

  Returns Promise<undefined | ElementValue>

  Description

  Removes the first element of the array

  Example

  <db>.shift(`hello`)
  Copy

startsWith

• startsWith(key): Promise<Element[]>

• Parameters

  • key: string

  Returns Promise<Element[]>

  Description

  Check if the key starts with the key in the database

  Example

  <db>.startsWith({key:`st.db`})
  Copy

subtract

• subtract(key, value): Promise<undefined | void | ElementValue>

• Parameters

  • key: string

    Data key

  • value: ElementValue

    The value, must be a number

  Returns Promise<undefined | void | ElementValue>

  Example

  <db>.subtract("coins", 50)
  Copy

type

• type(key): Promise<ElementValue>

• Parameters

  • key: string

    Type a key for the element

  Returns Promise<ElementValue>

  Description

  To get the value type of a given key element

  Example

  <db>.type(`st.db`)
  Copy

unshift

• unshift(key, value): Promise<undefined | ElementValue>

• Parameters

  • key: string

    Type a key for the element

  • value: ElementValue

  Returns Promise<undefined | ElementValue>

  Description

  To unshift an element to an array into data

  Example

  <db>.unshift(`version`,["v6"])
  Copy

valuesAll

• valuesAll(): Promise<ElementValue[]>

• Returns Promise<ElementValue[]>

  Example

  <db>.valuesAll()
  Copy

Static isNumeric

• isNumeric(val): boolean

• Parameters

  • val: string | number

  Returns boolean

  Description

  Check if the value is numeric