Class VehicleStorage

Hierarchy

VehicleStorage

Index

Constructors

constructor

Properties

Accessors

db
status

Methods

Constructors

constructor

new VehicleStorage(trapezeClient: TrapezeApiClient, updateDelay?: number, ttl?: number): VehicleStorage

- Defined in src/vehicle-storage.ts:51
Parameters
- trapezeClient: TrapezeApiClient
- Default value updateDelay: number = 10000
- Default value ttl: number = 0
Returns VehicleStorage

Properties

Private lock

lock: LockHandler = new LockHandler(false)

Private mDb

Private mStatus

mStatus: LoadStatus

Private trapezeClient

trapezeClient: TrapezeApiClient

Private updateDelay

updateDelay: number

Accessors

db

get db(): VehicleDb

- Defined in src/vehicle-storage.ts:59
Returns the underlying db

Returns VehicleDb

status

get status(): LoadStatus

- Defined in src/vehicle-storage.ts:72
Returns LoadStatus

Methods

fetch

fetch(positionType?: PositionType): Promise<LoadStatus>

- Defined in src/vehicle-storage.ts:76
Parameters
- Default value positionType: PositionType = "RAW"
Returns Promise<LoadStatus>

fetchSuccessOrThrow

fetchSuccessOrThrow(): Promise<ISuccessStatus>

- Defined in src/vehicle-storage.ts:125
Fetches or throws if an error status is provided

since

1.0.0

Returns Promise<ISuccessStatus>

getAllVehicles

getAllVehicles(lastUpdate?: number): Promise<IVehicleLocationList>

- Defined in src/vehicle-storage.ts:187
since

1.1.0

Parameters
- Default value lastUpdate: number = 0
Returns Promise<IVehicleLocationList>

getVehicle

getVehicle(id: VehicleId): Promise<TimestampedVehiclelocation>

- Defined in src/vehicle-storage.ts:141
Gets the vehicle or rejects with undefined if not known

Parameters
- id: VehicleId
Returns Promise<TimestampedVehiclelocation>

getVehicleByTripId

getVehicleByTripId(id: TripId): Promise<TimestampedVehiclelocation>

- Defined in src/vehicle-storage.ts:111
Gets the vehicle or rejects with undefined if not known

Parameters
- id: TripId
Returns Promise<TimestampedVehiclelocation>

getVehicles

getVehicles(left: number, right: number, top: number, bottom: number, lastUpdate?: number): Promise<IVehicleLocationList>

- Defined in src/vehicle-storage.ts:161
since

1.0.0

Parameters
- left: number
- right: number
- top: number
- bottom: number
- Default value lastUpdate: number = 0
Returns Promise<IVehicleLocationList>

updateRequired

updateRequired(): boolean

- Defined in src/vehicle-storage.ts:63
Returns boolean

Generated using TypeDoc