Class ClubRecord<T, V>

The ClubRecord<T extends SystemClubIDType | MainClubIDType>() class encapsulate any object with DataType value and provides utility method.

Type Parameters

T extends SystemClubIDType | MainClubIDType
V extends DataType

Hierarchy

DMap<T, V>
- ClubRecord

Index

Constructors

constructor

Properties

content

Constructors

constructor

new ClubRecord<T, V>(props: Record<T, V>): ClubRecord<T, V>
The ClubRecord<T extends SystemClubIDType | MainClubIDType>() class encapsulate any object with DataType value and provides utility method.
Type Parameters
- T extends string
- V extends DataType
Parameters
- props: Record<T, V>
Returns ClubRecord<T, V>
Overrides DMap.constructor
- Defined in builtin/data/record/ClubRecord.ts:23

Properties

`Protected` content

content: Record<T, V>

Methods

`Private` `Readonly` defaultMergeFunc

defaultMergeFunc(prevValue: V, newValue: V): V
Parameters
- prevValue: V
- newValue: V
Returns V
- Defined in builtin/data/record/ClubRecord.ts:27

filter

filter(matcher: ((k: T, v: V) => boolean)): DMap<T, V>
The filter() method filters records' key, value, which the matching function returned true.
Parameters
- matcher: ((k: T, v: V) => boolean)
  
  Matching function matches records' under provided condition.
  - - (k: T, v: V): boolean
    - Parameters
      
      k: T
      
      v: V
      
      Returns boolean
Returns DMap<T, V>
Inherited from DMap.filter
- Defined in util/data/DMap.ts:124

findKeys

findKeys(matcher: ((v: V) => boolean)): T[]
The findKeys() method finds records' key, which the matching function returned true.
Parameters
- matcher: ((v: V) => boolean)
  
  Matching function matches records' value under provided condition.
  - - (v: V): boolean
    - Parameters
      
      v: V
      
      Returns boolean
Returns T[]
Inherited from DMap.findKeys
- Defined in util/data/DMap.ts:151

findValues

findValues(matcher: ((v: V) => boolean)): V[]
The findValues() method finds records' value, which the matching function returned true.
Parameters
- matcher: ((v: V) => boolean)
  
  Matching function matches records' value under provided condition.
  - - (v: V): boolean
    - Parameters
      
      v: V
      
      Returns boolean
Returns V[]
Inherited from DMap.findValues
- Defined in util/data/DMap.ts:163

get

get(key: T): undefined | V
The get() method accesses the value of the given key.
Parameters
- key: T
  
  Provided key.
Returns undefined | V
Inherited from DMap.get
- Defined in util/data/DMap.ts:207

getRecord

getRecord(): Record<T, V>
The getRecord() method gives the Record of the DMap.

Returns Record<T, V>
Inherited from DMap.getRecord
- Defined in util/data/DMap.ts:239

groupBy

groupBy<G>(keyLocator: ((v: V) => G)): DMap<G, Record<T, V>[]>
The groupBy() method groups records by located values using keyLocator.
Type Parameters
- G extends string
Parameters
- keyLocator: ((v: V) => G)
  
  Key locator function finds the value that will be an object key.
  - - (v: V): G
    - Parameters
      
      v: V
      
      Returns G
Returns DMap<G, Record<T, V>[]>
Inherited from DMap.groupBy
- Defined in util/data/DMap.ts:132

hasKey

hasKey(c: T): boolean
The hasKey() method checks if the record contained a given key.
Parameters
- c: T
  
  Key that being searched.
Returns boolean
Inherited from DMap.hasKey
- Defined in util/data/DMap.ts:116

hasValue

hasValue(c: V): boolean
The hasValue() method checks if the record contained a given value.
Parameters
- c: V
  
  Value that being searched.
Returns boolean
Inherited from DMap.hasValue
- Defined in util/data/DMap.ts:175

insert

insert(value: V): void
The insert() method insert new value to the map and assign temporary uuid. For the document-based database, an inserted key-value will be created after changes are pushed to the server.
Parameters
- value: V
  
  Provided value.
Returns void
Inherited from DMap.insert
- Defined in util/data/DMap.ts:231

isLive

isLive(): boolean
The isLive() method determines the state of the DMap.

Returns boolean
Inherited from DMap.isLive
- Defined in util/data/DMap.ts:246

iterable

iterable(): [T, V][]
The iterable() method formats record to its iterable form.

Returns [T, V][]
Inherited from DMap.iterable
- Defined in util/data/DMap.ts:60

iterate

iterate(c: ((key: T, value: V, index: number, obj: Record<T, V>) => Promise<void>)): Promise<void>
The iterate() method iterates through record's key and value.
Parameters
- c: ((key: T, value: V, index: number, obj: Record<T, V>) => Promise<void>)
  
  Function that is called for every element of arr. Each time callbackFn executes.
  - - (key: T, value: V, index: number, obj: Record<T, V>): Promise<void>
    - Parameters
      
      key: T
      
      value: V
      
      index: number
      
      obj: Record<T, V>
      
      Returns Promise<void>
Returns Promise<void>
Inherited from DMap.iterate
- Defined in util/data/DMap.ts:100

iterateSync

iterateSync(c: ((key: T, value: V, index: number, obj: Record<T, V>) => void)): void
The iterateSync() method synchronously iterates through record's key and value.
Parameters
- c: ((key: T, value: V, index: number, obj: Record<T, V>) => void)
  
  Function that is called for every element of arr. Each time callbackFn executes.
  - - (key: T, value: V, index: number, obj: Record<T, V>): void
    - Parameters
      
      key: T
      
      value: V
      
      index: number
      
      obj: Record<T, V>
      
      Returns void
Returns void
Inherited from DMap.iterateSync
- Defined in util/data/DMap.ts:88

keyDiff

keyDiff(comparable: string[]): T[]
The keyDiff() method finds records' key, which different from elements in the given array.
Parameters
- comparable: string[]
  
  Provided keys array.
Returns T[]
Inherited from DMap.keyDiff
- Defined in util/data/DMap.ts:195

keyMatch

keyMatch(comparable: string[]): T[]
The keyMatch() method finds records' key, which matched with elements in the given array.
Parameters
- comparable: string[]
  
  Provided keys array.
Returns T[]
Inherited from DMap.keyMatch
- Defined in util/data/DMap.ts:183

keys

keys(): T[]
The keys() method gives record's key array.

Returns T[]
Inherited from DMap.keys
- Defined in util/data/DMap.ts:46

map

map<R>(c: ((key: T, value: V, index: number, obj: Record<T, V>) => R)): R[]
The map() method creates a new array populated with the results of calling a provided function on every element in the calling array.
Type Parameters
- R
Parameters
- c: ((key: T, value: V, index: number, obj: Record<T, V>) => R)
  
  Function that is called for every element of arr. Each time callbackFn executes, the returned value is added to newArray.
  - - (key: T, value: V, index: number, obj: Record<T, V>): R
    - Parameters
      
      key: T
      
      value: V
      
      index: number
      
      obj: Record<T, V>
      
      Returns R
Returns R[]
Inherited from DMap.map
- Defined in util/data/DMap.ts:68

mergeClubSection

mergeClubSection(mergeFunc?: ((prevValue: V, newValue: V) => V)): ClubRecord<string, V>
Parameters
- mergeFunc: ((prevValue: V, newValue: V) => V) = ...
  - - (prevValue: V, newValue: V): V
    - Parameters
      
      prevValue: V
      
      newValue: V
      
      Returns V
Returns ClubRecord<string, V>
- Defined in builtin/data/record/ClubRecord.ts:59

remove

remove(key: T): Record<T, V>[T]
Parameters
- key: T
Returns Record<T, V>[T]
Inherited from DMap.remove
- Defined in util/data/DMap.ts:250

set

set(key: T, value: V): void
The set() method set new key to the map.
Parameters
- key: T
  
  Provided key.
- value: V
  
  Provided value.
Returns void
Inherited from DMap.set
- Defined in util/data/DMap.ts:216

size

size(): number
The size() method gives record's size.

Returns number
Inherited from DMap.size
- Defined in util/data/DMap.ts:39

sort

sort(c: ((a: [T, V], b: [T, V]) => number)): DMap<T, V>
The sort() method sorts the elements of an array in place and returns the sorted array. The default sort order is ascending, built upon converting the elements into strings, then comparing their sequences of UTF-16 code units values.
Parameters
- c: ((a: [T, V], b: [T, V]) => number)
  
  Specifies a function that defines the sort order. If omitted, the array elements are converted to strings, then sorted according to each character's Unicode code point value.
  - - (a: [T, V], b: [T, V]): number
    - Parameters
      
      a: [T, V]
      
      b: [T, V]
      
      Returns number
Returns DMap<T, V>
Inherited from DMap.sort
- Defined in util/data/DMap.ts:80

transformToMainClubs

transformToMainClubs(mergeFunc?: ((prevValue: V, newValue: V) => V)): ClubRecord<string, V>
The transformToMainClubs() method transforms ClubRecord with SystemClubID indexes to new ClubRecord with MainClubID indexes by merging its properties using mergeFunc.
Parameters
- mergeFunc: ((prevValue: V, newValue: V) => V) = ...
  
  Merge function controls how an existed object will be merged. Look defaultMergeFunc for example.
  - - (prevValue: V, newValue: V): V
    - Parameters
      
      prevValue: V
      
      newValue: V
      
      Returns V
Returns ClubRecord<string, V>
- Defined in builtin/data/record/ClubRecord.ts:37

values

values(): V[]
The values() method gives record's values array.

Returns V[]
Inherited from DMap.values
- Defined in util/data/DMap.ts:53

Class ClubRecord<T, V>

Type Parameters

T extends SystemClubIDType | MainClubIDType

V extends DataType

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends string

V extends DataType

Parameters

props: Record<T, V>

Returns ClubRecord<T, V>

Properties

Protected content

Methods

Private Readonly defaultMergeFunc

Parameters

prevValue: V

newValue: V

Returns V

filter

Parameters

matcher: ((k: T, v: V) => boolean)

Parameters

k: T

v: V

Returns boolean

Returns DMap<T, V>

findKeys

Parameters

matcher: ((v: V) => boolean)

Parameters

v: V

Returns boolean

Returns T[]

findValues

Parameters

matcher: ((v: V) => boolean)

Parameters

v: V

Returns boolean

Returns V[]

get

Parameters

key: T

Returns undefined | V

getRecord

Returns Record<T, V>

groupBy

Type Parameters

G extends string

Parameters

keyLocator: ((v: V) => G)

Parameters

v: V

Returns G

Returns DMap<G, Record<T, V>[]>

hasKey

Parameters

c: T

Returns boolean

hasValue

Parameters

c: V

Returns boolean

insert

Parameters

value: V

Returns void

isLive

Returns boolean

iterable

Returns [T, V][]

iterate

Parameters

`Protected` content

`Private` `Readonly` defaultMergeFunc