Class LocoStoreBase`Abstract`

The base class for a LocoStore

Hierarchy

LocoStoreBase

Index

Constructors

Properties

nameStore objectStore

Methods

add deleteLoco getAllLocos getLoco getLocoFromIdentifier toString updateLoco

Constructors

constructor

new LocoStoreBase(): LocoStoreBase
Creates a new empty LocoStore

Returns LocoStoreBase
- Defined in locoStore.ts:95

Properties

`Protected` nameStore

nameStore: Map<string, number>

`Protected` objectStore

objectStore: Map<number, Loco>

Methods

add

add(loco): void
Adds a Loco to the LocoStore
Parameters
- loco: Loco
  
  The Loco to add to the LocoStore
Returns void
- Defined in locoStore.ts:104

deleteLoco

deleteLoco(identifier): boolean
Deletes a Loco from the store
Parameters
- identifier: string | number
  
  The identifier of the Loco to delete
Returns boolean
true if successful, false if not
- Defined in locoStore.ts:129

getAllLocos

getAllLocos(): IterableIterator<Loco>
Returns IterableIterator<Loco>
- Defined in locoStore.ts:120

getLoco

getLoco(identifier): Promise<Loco>
Parameters
- identifier: string | number
Returns Promise<Loco>
- Defined in locoStore.ts:109

`Protected` getLocoFromIdentifier

getLocoFromIdentifier(identifier): undefined | Loco
Used to get a loco given either the name or address
Parameters
- identifier: LocoIdentifier
  
  Identifier of Loco to find
Returns undefined | Loco
{@link Loco} if found, undefined if not.
- Defined in locoStore.ts:177

toString

toString(): string
Returns string
- Defined in locoStore.ts:164

updateLoco

updateLoco(identifier, name?, address?): void
Updates a Loco in the store
Parameters
- identifier: LocoIdentifier
  
  The identifier of the Loco to update
- Optional name: string
  
  The new name for the Loco
- Optional address: number
  
  The new address for the Loco
Returns void
- Defined in locoStore.ts:146

Generated using TypeDoc