Class SimulatedCollection<T>

The SimulatedCollection() class extends from Collection. It shares similar properties except the data is simulated locally.

Type Parameters

T extends DataType

Hierarchy

Collection<T, DMap<string, T[keyof T]>, null>
- SimulatedCollection

Index

Constructors

constructor

new SimulatedCollection<T>(name: string, preset: T, instructor?: ((simulated: DMap<string, T[keyof T]>) => void)): SimulatedCollection<T>
Type Parameters
- T extends DataType
Parameters
- name: string
- preset: T
- Optional instructor: ((simulated: DMap<string, T[keyof T]>) => void)
  - - (simulated: DMap<string, T[keyof T]>): void
    - Parameters
      
      simulated: DMap<string, T[keyof T]>
      
      Returns void
Returns SimulatedCollection<T>
Overrides Collection.constructor
- Defined in builtin/data/SimulatedCollection.ts:29

Properties

`Protected` `Readonly` dbInstance

dbInstance: null

`Protected` debug

debug: Debugger = ...

`Protected` `Readonly` name

name: string

`Private` `Readonly` simulatedContent

simulatedContent: DMap<string, T[keyof T]>

Methods

`Private` buildRef

buildRef(): LiveDMap<string, ReferableMapEntity<T[keyof T]>>
Returns LiveDMap<string, ReferableMapEntity<T[keyof T]>>
- Defined in builtin/data/SimulatedCollection.ts:202

`Protected` clearEntityReference

clearEntityReference<G>(data: G): Record<string, G[keyof G]>
The makeReferableEntities() method converts fetched data to ReferableMapEntity.
Type Parameters
- G extends DataType
Parameters
- data: G
  
  Fetched data
Returns Record<string, G[keyof G]>
Inherited from Collection.clearEntityReference
- Defined in util/database/Collection.ts:217

`Protected` collectionMutator

collectionMutator(d: DMap<string, T[keyof T]>): DataType
Parameters
- d: DMap<string, T[keyof T]>
Returns DataType
Overrides Collection.collectionMutator
- Defined in builtin/data/SimulatedCollection.ts:113

fetch

fetch(): Promise<DMap<string, ReferableMapEntity<T[keyof T]>>>
The fetch() method fetch the collection from database, mutate, and then save it as a cache.

Returns
Promise

Returns Promise<DMap<string, ReferableMapEntity<T[keyof T]>>>
Overrides Collection.fetch
- Defined in builtin/data/SimulatedCollection.ts:235

fetchNoRef

fetchNoRef(): Promise<DMap<string, T[keyof T]>>
The fetchNoRef() method fetch the collection from database without referable property, mutate, and then save it as a cache.

Returns
Promise

Returns Promise<DMap<string, T[keyof T]>>
Overrides Collection.fetchNoRef
- Defined in builtin/data/SimulatedCollection.ts:242

`Protected` handleChanges

handleChanges(changes: DataChanges[]): Promise<DataChanges[]>
The handleChanges() abstract method will be used to handle DataChanges to match the database required form. Note: Different databases require different procedures to process DataChanges.

Abstract
Parameters
- changes: DataChanges[]
  
  Received changes.
Returns Promise<DataChanges[]>
Overrides Collection.handleChanges
- Defined in builtin/data/SimulatedCollection.ts:56

`Protected` initInstance

initInstance(collectionName: string): null
Parameters
- collectionName: string
Returns null
Overrides Collection.initInstance
- Defined in builtin/data/SimulatedCollection.ts:105

`Private` loadBuildCache

loadBuildCache(): null | {
    content: {
        [key: string]: any;
    };
    exported: number;
}
Returns null | {
    content: {
        [key: string]: any;
    };
    exported: number;
}
- Defined in builtin/data/SimulatedCollection.ts:191

pushChanges

pushChanges(changes: ChangeList, strict?: boolean): Promise<boolean>
The pushChanges() method push incoming changes to the database.
Parameters
- changes: ChangeList
  
  Received changes.
- strict: boolean = true
  
  Only allow LiveDMap changes to be pushed to the database.
Returns Promise<boolean>
Inherited from Collection.pushChanges
- Defined in util/database/Collection.ts:95

readFromCache

readFromCache(autoFetch?: boolean): Promise<null | DMap<string, ReferableMapEntity<T[keyof T]>>>
Deprecated
This method should not be used since Simulated Collections are built and saved locally. The method fetch() would be more versatile in this case.
Parameters
- autoFetch: boolean = false
Returns Promise<null | DMap<string, ReferableMapEntity<T[keyof T]>>>
Overrides Collection.readFromCache
- Defined in builtin/data/SimulatedCollection.ts:229

readFromCacheNoRef

readFromCacheNoRef(autoFetch?: boolean): Promise<null | DMap<string, T[keyof T]>>
The readFromCacheNoRef() method retrieve data from saved cache without referable property.
Parameters
- autoFetch: boolean = false
  
  Automatically fetch data from the database if it is not presented.
Returns Promise<null | DMap<string, T[keyof T]>>
Inherited from Collection.readFromCacheNoRef
- Defined in util/database/Collection.ts:175

`Protected` retrieveCollection

retrieveCollection(): Promise<DMap<string, T[keyof T]>>
The retrieveCollection() abstract method will be called internally to fetch collection data. Note: Different databases require different procedures to access its collection.

Abstract

Returns Promise<DMap<string, T[keyof T]>>
Overrides Collection.retrieveCollection
- Defined in builtin/data/SimulatedCollection.ts:109

`Private` saveBuildCache

saveBuildCache(): void
Returns void
- Defined in builtin/data/SimulatedCollection.ts:195

setDefaultMutator

setDefaultMutator(mutator: CollectionMutator<DMap<string, T[keyof T]>>): SimulatedCollection<T>
The setDefaultMutator() method set Collection's defaultMutator, which will be used when resources are being fetched automatically.
Parameters
- mutator: CollectionMutator<DMap<string, T[keyof T]>>
  
  Mutator mutates raw collection data from the database to certain format check Mutator for some built-in mutators.
Returns SimulatedCollection<T>
Inherited from Collection.setDefaultMutator
- Defined in util/database/Collection.ts:85

`Protected` verifyChanges

verifyChanges(changes: DataChanges[]): Promise<boolean>
The verifyChanges() abstract method will be used to verify changes pushed to the database. Note: Different databases may require different procedures.

Abstract
Parameters
- changes: DataChanges[]
  
  Expected changes.
Returns Promise<boolean>
Overrides Collection.verifyChanges
- Defined in builtin/data/SimulatedCollection.ts:116

Class SimulatedCollection<T>

Type Parameters

T extends DataType

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends DataType

Parameters

name: string

preset: T

Optional instructor: ((simulated: DMap<string, T[keyof T]>) => void)

Parameters

simulated: DMap<string, T[keyof T]>

Returns void

Returns SimulatedCollection<T>

Properties

Protected Readonly dbInstance

Protected debug

Protected Readonly name

Private Readonly simulatedContent

Methods

Private buildRef

Returns LiveDMap<string, ReferableMapEntity<T[keyof T]>>

Protected clearEntityReference

Type Parameters

G extends DataType

Parameters

data: G

Returns Record<string, G[keyof G]>

Protected collectionMutator

Parameters

d: DMap<string, T[keyof T]>

Returns DataType

fetch

Returns

Returns Promise<DMap<string, ReferableMapEntity<T[keyof T]>>>

fetchNoRef

Returns

Returns Promise<DMap<string, T[keyof T]>>

Protected handleChanges

Abstract

Parameters

changes: DataChanges[]

Returns Promise<DataChanges[]>

Protected initInstance

Parameters

collectionName: string

Returns null

Private loadBuildCache

Returns null | { content: { [key: string]: any; }; exported: number; }

pushChanges

Parameters

changes: ChangeList

strict: boolean = true

Returns Promise<boolean>

readFromCache

Deprecated

Parameters

autoFetch: boolean = false

Returns Promise<null | DMap<string, ReferableMapEntity<T[keyof T]>>>

readFromCacheNoRef

Parameters

autoFetch: boolean = false

Returns Promise<null | DMap<string, T[keyof T]>>

Protected retrieveCollection

Abstract

Returns Promise<DMap<string, T[keyof T]>>

Private saveBuildCache

Returns void

setDefaultMutator

Parameters

mutator: CollectionMutator<DMap<string, T[keyof T]>>

Returns SimulatedCollection<T>

Protected verifyChanges

Abstract

`Optional` instructor: ((simulated: DMap<string, T[keyof T]>) => void)

`Protected` `Readonly` dbInstance

`Protected` debug

`Protected` `Readonly` name

`Private` `Readonly` simulatedContent

`Private` buildRef

`Protected` clearEntityReference

`Protected` collectionMutator

`Protected` handleChanges

`Protected` initInstance

`Private` loadBuildCache

Returns null | {
content: {
[key: string]: any;
};
exported: number;
}

`Protected` retrieveCollection

`Private` saveBuildCache

`Protected` verifyChanges