Class DataMapper<TBot, TOriginal>`Abstract` `Experimental`

An advanced data mapper.

Type Parameters

TBot
TOriginal extends { id: string | number }

Hierarchy (View Summary)

Loggable
- DataMapper

Index

Constructors

Properties

bot log obj shouldRefresh timeSinceLastReload

Methods

checkForRefresh fetchArrayFactory fetchFactory refresh reload set withoutRefresh

Constructors

constructor

new DataMapper<TBot, TOriginal extends { id: string | number }>(
    bot: TBot,
    data: TOriginal,
    registry: { [key: string | number]: DataMapper<TBot, TOriginal> },
): DataMapper<TBot, TOriginal>
Experimental
Type Parameters
- TBot
- TOriginal extends { id: string | number }
Parameters
- bot: TBot
- data: TOriginal
- registry: { [key: string | number]: DataMapper<TBot, TOriginal> }
Returns DataMapper<TBot, TOriginal>
Overrides Loggable.constructor
- Defined in mapper.ts:15

Properties

`Experimental`bot

bot: TBot

`Readonly` `Experimental`log

log: Logger<ILogObj> = ...

`Protected` `Experimental`obj

`Protected` `Experimental`shouldRefresh

shouldRefresh: boolean = true

`Protected` `Experimental`timeSinceLastReload

timeSinceLastReload: Date

Methods

`Protected`checkForRefresh

checkForRefresh(): Promise<void>
Experimental
Returns Promise<void>
- Defined in mapper.ts:72

`Protected`fetchArrayFactory

fetchArrayFactory<T, TBase extends { id: string | number }>(
    data: TBase[],
    factory: new (bot: TBot, data: TBase) => T,
    registry: { [key: string | number]: T },
): T[]
Experimental
Type Parameters
- T
- TBase extends { id: string | number }
Parameters
- data: TBase[]
- factory: new (bot: TBot, data: TBase) => T
- registry: { [key: string | number]: T }
Returns T[]
- Defined in mapper.ts:80

`Protected`fetchFactory

fetchFactory<T, TBase extends { id: string | number }>(
    data: TBase,
    factory: new (bot: TBot, data: TBase) => T,
    registry: { [key: string | number]: T },
): T
Experimental
Type Parameters
- T
- TBase extends { id: string | number }
Parameters
- data: TBase
- factory: new (bot: TBot, data: TBase) => T
- registry: { [key: string | number]: T }
Returns T
- Defined in mapper.ts:89

`Abstract`refresh

refresh(): Promise<void>
Experimental
Returns Promise<void>
- Defined in mapper.ts:55

`Abstract`reload

reload(): Promise<void>
Experimental
Returns Promise<void>
- Defined in mapper.ts:56

`Protected` `Abstract`set

set<TKey extends string | number | symbol>(
name: TKey,
value: TOriginal[TKey],
): void
Experimental
Type Parameters
- TKey extends string | number | symbol
Parameters
- name: TKey
- value: TOriginal[TKey]
Returns void
- Defined in mapper.ts:57

withoutRefresh

withoutRefresh<T>(func: (obj: this) => T): T
Experimental
Type Parameters
- T
Parameters
- func: (obj: this) => T
Returns T
- Defined in mapper.ts:59