Class Collection<T, M, C>`Abstract`

Type Parameters

T extends DataType

A collection data type definition.
M = any

A CollectionMutator received collection type definition.
C = any

Hierarchy

Collection
- FirestoreCollection
- SimulatedCollection

Index

Constructors

constructor

new Collection<T, M, C>(name: string): Collection<T, M, C>
The Collection() class hold data resources. User can choose either fetch from database or cache.
Type Parameters
- T extends DataType
  
  A collection data type definition.
- M = any
  
  A CollectionMutator received collection type definition.
- C = any
Parameters
- name: string
  
  The collection name.
Returns Collection<T, M, C>
- Defined in util/database/Collection.ts:43

Properties

`Protected` `Abstract` collectionMutator

collectionMutator: CollectionMutator<M>

`Protected` `Readonly` dbInstance

dbInstance: C

`Protected` debug

debug: Debugger = ...

`Protected` `Readonly` name

name: string

`Private` `Readonly` resourcePath

resourcePath: string

`Private` rootPath

rootPath: string = ...

Methods

`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]>
- Defined in util/database/Collection.ts:217

fetch

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

Returns
Promise
Parameters
- Optional mutator: CollectionMutator<M> = ...
  
  Mutator mutates raw collection data from the database to certain format check Mutator for some built-in mutators.
Returns Promise<LiveDMap<string, ReferableMapEntity<T[keyof T]>>>
- Defined in util/database/Collection.ts:134

fetchNoRef

fetchNoRef(mutator??: CollectionMutator<M>): Promise<LiveDMap<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
Parameters
- Optional mutator: CollectionMutator<M> = ...
  
  Mutator mutates raw collection data from the database to certain format check Mutator for some built-in mutators.
Returns Promise<LiveDMap<string, T[keyof T]>>
- Defined in util/database/Collection.ts:198

`Protected` `Abstract` handleChanges

handleChanges(changes: DataChanges[]): Promise<DataChanges[]>
Protected
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[]>
- Defined in util/database/Collection.ts:67

`Protected` `Abstract` initInstance

initInstance(collectionName: string): C
Parameters
- collectionName: string
Returns C
- Defined in util/database/Collection.ts:49

`Private` makeReferableEntities

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

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>
- Defined in util/database/Collection.ts:95

readFromCache

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

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]>>
- Defined in util/database/Collection.ts:175

`Protected` `Abstract` retrieveCollection

retrieveCollection(): Promise<M>
Protected
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<M>
- Defined in util/database/Collection.ts:57

setDefaultMutator

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

`Protected` `Abstract` verifyChanges

verifyChanges(changes: DataChanges[]): Promise<boolean>
Protected
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>
- Defined in util/database/Collection.ts:79

Class Collection<T, M, C>Abstract

Type Parameters

T extends DataType

M = any

C = any

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends DataType

M = any

C = any

Parameters

name: string

Returns Collection<T, M, C>

Properties

Protected Abstract collectionMutator

Protected Readonly dbInstance

Protected debug

Protected Readonly name

Private Readonly resourcePath

Private rootPath

Methods

Protected clearEntityReference

Type Parameters

G extends DataType

Parameters

data: G

Returns Record<string, G[keyof G]>

fetch

Returns

Parameters

Optional mutator: CollectionMutator<M> = ...

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

fetchNoRef

Returns

Parameters

Optional mutator: CollectionMutator<M> = ...

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

Protected Abstract handleChanges

Abstract

Parameters

changes: DataChanges[]

Returns Promise<DataChanges[]>

Protected Abstract initInstance

Parameters

collectionName: string

Returns C

Private makeReferableEntities

Type Parameters

G extends DataType

Parameters

data: DataType

Returns Record<string, ReferableMapEntity<G>>

pushChanges

Parameters

changes: ChangeList

strict: boolean = true

Returns Promise<boolean>

readFromCache

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 Abstract retrieveCollection

Abstract

Returns Promise<M>

setDefaultMutator

Parameters

mutator: CollectionMutator<M>

Returns Collection<T, M, C>

Protected Abstract verifyChanges

Abstract

Class Collection<T, M, C>`Abstract`

`Protected` `Abstract` collectionMutator

`Protected` `Readonly` dbInstance

`Protected` debug

`Protected` `Readonly` name

`Private` `Readonly` resourcePath

`Private` rootPath

`Protected` clearEntityReference

`Optional` mutator: CollectionMutator<M> = ...

`Optional` mutator: CollectionMutator<M> = ...

`Protected` `Abstract` handleChanges

`Protected` `Abstract` initInstance

`Private` makeReferableEntities

`Protected` `Abstract` retrieveCollection

`Protected` `Abstract` verifyChanges