Class RainlinkDatabase<G>

A class for storing data using key like Map. Aka: reduce version of Map

Type Parameters

G = unknown

Hierarchy (view full)

RainlinkDatabase
- RainlinkNodeManager
- RainlinkPlayerManager

Index

Constructors

Accessors

size values full

Methods

get delete clear set forEach

Constructors

constructor

new RainlinkDatabase<G>(): RainlinkDatabase<G>
Type Parameters
- G = unknown
Returns RainlinkDatabase<G>

Accessors

size

get size(): number
Get how many elements of current database

Returns number
number
- Defined in src/Utilities/RainlinkDatabase.ts:60

values

get values(): G[]
Get all current values of current database

Returns G[]
unknown[]
- Defined in src/Utilities/RainlinkDatabase.ts:68

full

get full(): [string, G][]
Get all current values of current database

Returns [string, G][]
unknown[]
- Defined in src/Utilities/RainlinkDatabase.ts:76

Methods

get

get<D>(key): undefined | D
Get data from database
Type Parameters
- D = G
Parameters
- key: string
  key of that data
Returns undefined | D
D
- Defined in src/Utilities/RainlinkDatabase.ts:13

delete

delete<D>(key): undefined | D
detete data from database and returns the deleted data
Type Parameters
- D = G
Parameters
- key: string
  key of that data
Returns undefined | D
D
- Defined in src/Utilities/RainlinkDatabase.ts:22

clear

clear(): void
detete all data from database

Returns void
- Defined in src/Utilities/RainlinkDatabase.ts:31

set

set<D>(key, data): undefined | D
Set data from database
Type Parameters
- D = G
Parameters
- key: string
  the key you want to set
- data: D
  data of that key
Returns undefined | D
D
- Defined in src/Utilities/RainlinkDatabase.ts:41

forEach

forEach(callback): void
executes a provided function once for each array element.
Parameters
- callback: ((value: G, key: string) => unknown)
  Callback function
  - - (value, key): unknown
    - Parameters
      value: G
      key: string
      Returns unknown
Returns void
- Defined in src/Utilities/RainlinkDatabase.ts:50