Class Table

Hierarchy

Database
- Table

Index

Constructors

constructor

Properties

_database autoDecrypt options? readyInDate tableName

Accessors

uptime

Methods

Constructors

constructor

new Table(tableName, _database): Table
Parameters
- tableName: string
- _database: Database
Returns Table
Overrides Database.constructor
- Defined in utils/Table.ts:7

Properties

`Private` `Readonly` _database

_database: Database

`Readonly` autoDecrypt

autoDecrypt: Boolean

`Optional` `Readonly` options

options?: DatabaseOptions

`Readonly` readyInDate

readyInDate: Date

`Readonly` tableName

tableName: string

Accessors

uptime

get uptime(): number
Returns number
Description

Returns database connection uptime!

Example
```
console.log(`Database is up for ${db.uptime} ms.`);
```
Inherited from Database.uptime
- Defined in utils/Database.ts:187

Methods

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)
```
Inherited from Database.add
- Defined in utils/Database.ts:307

all

all(limit?): Promise<{
ID: string;
data: ElementValue;
}[]>
Parameters
- limit: number = 0
  
  default = 0
Returns Promise<{
ID: string;
data: ElementValue;
}[]>
Description

Returns all elements in Database

Example
```
<db>.all()
```
Overrides Database.all
- Defined in utils/Table.ts:34

clear

clear(): Promise<void>
Returns Promise<void>
Description

Clean all data

Example
```
<db>.clear()
```
Overrides Database.clear
- Defined in utils/Table.ts:54

decryptString

decryptString(value): string | number | void
Parameters
- value: string
Returns string | number | void
Inherited from Database.decryptString
- Defined in utils/Database.ts:211

delete

delete(key): Promise<undefined | string>
Parameters
- key: string
  
  Type a key for the element
Returns Promise<undefined | string>

Promise
Description

delete element from database

Example
```
<db>.delete(`version`)
```
Overrides Database.delete
- Defined in utils/Table.ts:58

deleteAll

deleteAll(): Promise<void>
Returns Promise<void>
Description

Delete all data

Example
```
<db>.deleteAll()
```
Inherited from Database.deleteAll
- Defined in utils/Database.ts:238

double

double(key): Promise<undefined | void | ElementValue>
Parameters
- key: string
  
  Data key
Returns Promise<undefined | void | ElementValue>
Example
```
<db>.double("coins")
```
Inherited from Database.double
- Defined in utils/Database.ts:327

encryptString

encryptString(value?): string
Parameters
- value: string = "hi"
Returns string
Inherited from Database.encryptString
- Defined in utils/Database.ts:178

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`})
```
Inherited from Database.endsWith
- Defined in utils/Database.ts:257

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`)
```
Inherited from Database.fetch
- Defined in utils/Database.ts:78

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")
```
Inherited from Database.filter
- Defined in utils/Database.ts:268

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`)
```
Overrides Database.get
- Defined in utils/Table.ts:14

getTable

getTable(): Promise<any>
Returns Promise<any>
- Defined in utils/Table.ts:39

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`)
```
Overrides Database.has
- Defined in utils/Table.ts:20

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`})
```
Inherited from Database.includes
- Defined in utils/Database.ts:278

isEncryptString

isEncryptString(value): boolean | void
Parameters
- value: any
Returns boolean | void
Inherited from Database.isEncryptString
- Defined in utils/Database.ts:222

keysAll

keysAll(): Promise<string[]>
Returns Promise<string[]>
Example
```
<db>.keysAll()
```
Inherited from Database.keysAll
- Defined in utils/Database.ts:203

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)
```
Inherited from Database.math
- Defined in utils/Database.ts:291

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)
```
Inherited from Database.multiply
- Defined in utils/Database.ts:317

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`)
```
Inherited from Database.pop
- Defined in utils/Database.ts:102

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")
```
Inherited from Database.pull
- Defined in utils/Database.ts:117

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")
```
Inherited from Database.push
- Defined in utils/Database.ts:129

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`})
```
Inherited from Database.remove
- Defined in utils/Database.ts:39

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"})
```
Overrides Database.set
- Defined in utils/Table.ts:26

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`)
```
Inherited from Database.shift
- Defined in utils/Database.ts:87

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`})
```
Inherited from Database.startsWith
- Defined in utils/Database.ts:247

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)
```
Inherited from Database.subtract
- Defined in utils/Database.ts:337

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`)
```
Inherited from Database.type
- Defined in utils/Database.ts:159

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"])
```
Inherited from Database.unshift
- Defined in utils/Database.ts:144

valuesAll

valuesAll(): Promise<ElementValue[]>
Returns Promise<ElementValue[]>
Example
```
<db>.valuesAll()
```
Inherited from Database.valuesAll
- Defined in utils/Database.ts:195

`Static` isNumeric

isNumeric(val): boolean
Parameters
- val: string | number
Returns boolean

Description

Check if the value is numeric
Inherited from Database.isNumeric
- Defined in utils/Database.ts:346

Class Table

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

tableName: string

_database: Database

Returns Table

Properties

Private Readonly _database

Readonly autoDecrypt

Optional Readonly options

Readonly readyInDate

Readonly tableName

Accessors

uptime

Returns number

Description

Example

Methods

add

Parameters

key: string

value: ElementValue

Returns Promise<undefined | void | ElementValue>

Example

all

Parameters

limit: number = 0

Returns Promise<{ ID: string; data: ElementValue; }[]>

Description

Example

clear

Returns Promise<void>

Description

Example

decryptString

Parameters

value: string

Returns string | number | void

delete

Parameters

key: string

Returns Promise<undefined | string>

Description

Example

deleteAll

Returns Promise<void>

Description

Example

double

Parameters

key: string

Returns Promise<undefined | void | ElementValue>

Example

encryptString

Parameters

value: string = "hi"

Returns string

endsWith

Parameters

key: string

Returns Promise<Element[]>

Description

Example

fetch

Parameters

key: string

Returns Promise<void | ElementValue>

Description

Example

filter

Parameters

key: string

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

`Private` `Readonly` _database

`Readonly` autoDecrypt

`Optional` `Readonly` options

`Readonly` readyInDate

`Readonly` tableName

Returns Promise<{
ID: string;
data: ElementValue;
}[]>

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

`Optional` new_value: string | number