Class FeatureCache

Feature Row Cache for a single feature table

Hierarchy

FeatureCache

Index

Constructors

Properties

DEFAULT_CACHE_MAX_SIZE

Methods

clear clearAndResize get getMaxSize getSize put remove removeFeature resize

Constructors

constructor

new FeatureCache(size?: number): FeatureCache
Constructor
Parameters
- size: number = FeatureCache.DEFAULT_CACHE_MAX_SIZE
  
  max feature rows to retain in the cache
Returns FeatureCache
- Defined in lib/features/user/featureCache.ts:26

Properties

`Static` `Readonly` DEFAULT_CACHE_MAX_SIZE

DEFAULT_CACHE_MAX_SIZE: 1000 = 1000

Default max number of feature rows to retain in cache

Methods

clear

clear(): void
Clear the cache

Returns void
- Defined in lib/features/user/featureCache.ts:108

clearAndResize

clearAndResize(maxSize: number): void
Clear and resize the cache
Parameters
- maxSize: number
  
  max size of the cache
Returns void
- Defined in lib/features/user/featureCache.ts:127

get

get(featureId: number): FeatureRow
Get the cached feature row by feature id

Returns
feature row or null
Parameters
- featureId: number
  
  feature row id
Returns FeatureRow
- Defined in lib/features/user/featureCache.ts:54

getMaxSize

getMaxSize(): number
Get the cache max size

Returns
max size

Returns number
- Defined in lib/features/user/featureCache.ts:36

getSize

getSize(): number
Get the current cache size, number of feature rows cached

Returns
cache size

Returns number
- Defined in lib/features/user/featureCache.ts:45

put

put(featureRow: FeatureRow): FeatureRow
Cache the feature row

Returns
previous cached feature row or null
Parameters
- featureRow: FeatureRow
  
  feature row
Returns FeatureRow
- Defined in lib/features/user/featureCache.ts:71

remove

remove(featureId: number): FeatureRow
Remove the cached feature row by id

Returns
removed feature row or null
Parameters
- featureId: number
  
  feature row id
Returns FeatureRow
- Defined in lib/features/user/featureCache.ts:99

removeFeature

removeFeature(featureRow: FeatureRow): FeatureRow
Remove the cached feature row

Returns
removed feature row or null
Parameters
- featureRow: FeatureRow
  
  feature row
Returns FeatureRow
- Defined in lib/features/user/featureCache.ts:90

resize

resize(maxSize: number): void
Resize the cache
Parameters
- maxSize: number
  
  max size
Returns void
- Defined in lib/features/user/featureCache.ts:116

Generated using TypeDoc