Class FlightCollection

A collection of flights. Provides playFlight API, which returns a FlightPlayer. Emits playerChanged event, whenever another flight is played.

Hierarchy (View Summary)

Collection<FlightInstance>
- FlightCollection

Index

Accessors

player size uniqueKey

Constructors

Methods

_checkUniqueness _remove [iterator] add clear destroy getByKey has hasKey remove setPlayerForFlight from

Properties

_array added playerChanged removed

Accessors

player

get player(): FlightPlayer | undefined
Returns FlightPlayer | undefined
- Defined in src/util/flight/flightCollection.ts:30

size

get size(): number
Returns number
Inherited from Collection.size
- Defined in src/util/collection.ts:71

uniqueKey

get uniqueKey(): keyof T | undefined
The key by which to check uniqueness against. undefined if no uniqueness constraint is set.

Returns keyof T | undefined
Inherited from Collection.uniqueKey
- Defined in src/util/collection.ts:67

Constructors

constructor

new FlightCollection(app: VcsApp): FlightCollection
Parameters
- app: VcsApp
Returns FlightCollection
Overrides Collection.constructor
- Defined in src/util/flight/flightCollection.ts:21

Methods

`Protected`_checkUniqueness

_checkUniqueness(item: FlightInstance): boolean
Parameters
- item: FlightInstance
Returns boolean
Inherited from Collection._checkUniqueness
- Defined in src/util/collection.ts:86

`Protected`_remove

_remove(item: FlightInstance): number
Protected
internal remove function, to remove an item from the collection, does not raise an event.
Parameters
- item: FlightInstance
Returns number
returns the index of the removed item or -1 if the item has not been found.
Inherited from Collection._remove
- Defined in src/util/collection.ts:123

[iterator]

"[iterator]"(): Generator<FlightInstance>
Returns Generator<FlightInstance>
Inherited from Collection.[iterator]
- Defined in src/util/collection.ts:57

add

add(item: FlightInstance): number | null
Adds an item to the collection.
Parameters
- item: FlightInstance
  the item to be inserted
Returns number | null
the index at which the item was inserted
Inherited from Collection.add
- Defined in src/util/collection.ts:108

clear

clear(): void
clears the array

Returns void
Inherited from Collection.clear
- Defined in src/util/collection.ts:164

destroy

destroy(): void
Destroys the collection, clearing the array and all its events

Returns void
Overrides Collection.destroy
- Defined in src/util/flight/flightCollection.ts:67

getByKey

getByKey(value: unknown): FlightInstance | undefined
Returns an item identified by the unique constraint key. Returns null, if there is no uniqueness constraint.
Parameters
- value: unknown
  the value to test against. does a shallow comparison, if the passed a non-atomic value
Returns FlightInstance | undefined
Inherited from Collection.getByKey
- Defined in src/util/collection.ts:79

has

has(item: FlightInstance): boolean
Equivalent to Array.prototype.includes
Parameters
- item: FlightInstance
Returns boolean
Inherited from Collection.has
- Defined in src/util/collection.ts:146

hasKey

hasKey(value: unknown): boolean | undefined
Returns true, if the key exists. Returns undefined, if there is no uniqueness constraint.
Parameters
- value: unknown
Returns boolean | undefined
Inherited from Collection.hasKey
- Defined in src/util/collection.ts:154

remove

remove(item: FlightInstance): void
Removes an item from the collection
Parameters
- item: FlightInstance
Returns void
Overrides Collection.remove
- Defined in src/util/flight/flightCollection.ts:34

setPlayerForFlight

setPlayerForFlight(flight: FlightInstance): Promise<FlightPlayer | undefined>
Creates a FlightPlayer for a flight instance, if not already existing for provided instance
Parameters
- flight: FlightInstance
Returns Promise<FlightPlayer | undefined>
- Defined in src/util/flight/flightCollection.ts:46

`Static`from

from<F>(iterable: Iterable<F>, uniqueKey?: false | keyof F): Collection<F>
Creates a Collection from an iterable, such as an Array.
Type Parameters
- F
Parameters
- iterable: Iterable<F>
- OptionaluniqueKey: false | keyof F
  a key to maintain uniquely within the collection. passing false disables uniqueness.
Returns Collection<F>
Inherited from Collection.from
- Defined in src/util/collection.ts:13

Properties

`Protected`_array

_array: FlightInstance[]

added

added: VcsEvent<FlightInstance>

Event raised if an item is added. Is passed the added item.

playerChanged

playerChanged: VcsEvent<FlightPlayer | undefined>

removed

removed: VcsEvent<FlightInstance>

Event raised if an item is removed. Is passed the removed item.