Class ClientMemoryManager

Hierarchy

ReadOnlyClientMemoryManager
- ClientMemoryManager

Index

Constructors

constructor

Properties

Constructors

constructor

new ClientMemoryManager(prevMemories: FilledEntityMap, curMemories: FilledEntityMap, allEntities: EntityBase[], sessionInfo: SessionInfo): ClientMemoryManager

Overrides ReadOnlyClientMemoryManager.constructor
- Defined in Memory/ClientMemoryManager.ts:168
Parameters
- prevMemories: FilledEntityMap
- curMemories: FilledEntityMap
- allEntities: EntityBase[]
- sessionInfo: SessionInfo
Returns ClientMemoryManager

Properties

Protected __expired

__expired: boolean

Protected allEntities

allEntities: EntityBase[] = []

curMemories

curMemories: FilledEntityMap

prevMemories

prevMemories: FilledEntityMap

Methods

AsReadOnly

AsReadOnly(): ReadOnlyClientMemoryManager

- Defined in Memory/ClientMemoryManager.ts:174
Returns ReadOnlyClientMemoryManager

Copy

Copy(entityNameFrom: string, entityNameTo: string): void

- Defined in Memory/ClientMemoryManager.ts:256
Copy values from one entity to another

Parameters
- entityNameFrom: string
  
  Source Entity
- entityNameTo: string
  
  Destination Entity
Returns void

Delete

Delete(entityName: string, value?: string | null): void

- Defined in Memory/ClientMemoryManager.ts:220
Parameters
- entityName: string
- Default value value: string | null = null
Returns void

DeleteAll

DeleteAll(): void

- Defined in Memory/ClientMemoryManager.ts:234
Returns void

DeleteAllExcept

DeleteAllExcept(...saveEntityNames: string[]): void

- Defined in Memory/ClientMemoryManager.ts:239
Delete all entity values apart from any included in the list of saveEntityNames

Parameters
- Rest ...saveEntityNames: string[]
  
  Array of entity names not to forget
Returns void

Expire

Expire(): void

Inherited from ReadOnlyClientMemoryManager.Expire
- Defined in Memory/ClientMemoryManager.ts:27
Returns void

Get

Get<T>(entityName: string, converter?: undefined | function): MemoryManagerReturnType<T>

Inherited from ReadOnlyClientMemoryManager.Get
- Defined in Memory/ClientMemoryManager.ts:45
Get current value of entity

Type parameters
- T
Parameters
- entityName: string
- Optional converter: undefined | function
Returns MemoryManagerReturnType<T>

GetPrevious

GetPrevious<T>(entityName: string, converter?: undefined | function): MemoryManagerReturnType<T>

Inherited from ReadOnlyClientMemoryManager.GetPrevious
- Defined in Memory/ClientMemoryManager.ts:52
Get value of entity before most recent input

Type parameters
- T
Parameters
- entityName: string
- Optional converter: undefined | function
Returns MemoryManagerReturnType<T>

SessionInfo

SessionInfo(): SessionInfo

Inherited from ReadOnlyClientMemoryManager.SessionInfo
- Defined in Memory/ClientMemoryManager.ts:59
Get information about the current running session

Returns SessionInfo

Set

Set(entityName: string, value: string | number | boolean | object | string[] | number[] | boolean[] | object[]): void

- Defined in Memory/ClientMemoryManager.ts:178
Parameters
- entityName: string
- value: string | number | boolean | object | string[] | number[] | boolean[] | object[]
Returns void

Protected __FindEntity

__FindEntity(entityName: string): EntityBase | undefined

Inherited from ReadOnlyClientMemoryManager.__FindEntity
- Defined in Memory/ClientMemoryManager.ts:31
Parameters
- entityName: string
Returns EntityBase | undefined

Protected __ToString

__ToString(value: string | number | boolean | object): string

Inherited from ReadOnlyClientMemoryManager.__ToString
- Defined in Memory/ClientMemoryManager.ts:35
Parameters
- value: string | number | boolean | object
Returns string

Static AS_BOOLEAN

AS_BOOLEAN(memoryValues: MemoryValue[]): boolean | null

Inherited from ReadOnlyClientMemoryManager.AS_BOOLEAN
- Defined in Memory/ClientMemoryManager.ts:111
Parameters
- memoryValues: MemoryValue[]
Returns boolean | null

Static AS_BOOLEAN_LIST

AS_BOOLEAN_LIST(memoryValues: MemoryValue[]): boolean[]

Inherited from ReadOnlyClientMemoryManager.AS_BOOLEAN_LIST
- Defined in Memory/ClientMemoryManager.ts:128
Parameters
- memoryValues: MemoryValue[]
Returns boolean[]

Static AS_NUMBER

AS_NUMBER(memoryValues: MemoryValue[]): number | null

Inherited from ReadOnlyClientMemoryManager.AS_NUMBER
- Defined in Memory/ClientMemoryManager.ts:87
Parameters
- memoryValues: MemoryValue[]
Returns number | null

Static AS_NUMBER_LIST

AS_NUMBER_LIST(memoryValues: MemoryValue[]): number[]

Inherited from ReadOnlyClientMemoryManager.AS_NUMBER_LIST
- Defined in Memory/ClientMemoryManager.ts:101
Parameters
- memoryValues: MemoryValue[]
Returns number[]

Static AS_STRING

AS_STRING(memoryValues: MemoryValue[]): string | null

Inherited from ReadOnlyClientMemoryManager.AS_STRING
- Defined in Memory/ClientMemoryManager.ts:74
Parameters
- memoryValues: MemoryValue[]
Returns string | null

Static AS_STRING_LIST

AS_STRING_LIST(memoryValues: MemoryValue[]): string[]

Inherited from ReadOnlyClientMemoryManager.AS_STRING_LIST
- Defined in Memory/ClientMemoryManager.ts:78
Parameters
- memoryValues: MemoryValue[]
Returns string[]

Static AS_VALUE

AS_VALUE(memoryValues: MemoryValue[]): MemoryValue | null

Inherited from ReadOnlyClientMemoryManager.AS_VALUE
- Defined in Memory/ClientMemoryManager.ts:63
Parameters
- memoryValues: MemoryValue[]
Returns MemoryValue | null

Static AS_VALUE_LIST

AS_VALUE_LIST(memoryValues: MemoryValue[]): MemoryValue[]

Inherited from ReadOnlyClientMemoryManager.AS_VALUE_LIST
- Defined in Memory/ClientMemoryManager.ts:70
Parameters
- memoryValues: MemoryValue[]
Returns MemoryValue[]

Generated using TypeDoc