Class: ProxiedPerformancePlanProperty<P, K>

Defined in: src/sdk/performance/ProxiedPerformancePlanProperty.ts:23

Proxied MutableSubscribable that mirrors a property to be accessed by PerformancePlanProxy

Extends

• AbstractSubscribable<ValueType<P, K>>

Type Parameters

Type Parameter
P extends PerformancePlan
K extends keyof P

Implements

• MutableSubscribable<ValueType<P, K>>

Constructors

Constructor

new ProxiedPerformancePlanProperty<P, K>(proxy, key, differentiateBetweenFlightPlans): ProxiedPerformancePlanProperty<P, K>

Defined in: src/sdk/performance/ProxiedPerformancePlanProperty.ts:40

Ctor

Parameters

Parameter	Type	Description
proxy	PerformancePlanProxy<P>	the proxy this property belongs to
key	K	property key
differentiateBetweenFlightPlans	boolean	whether the property, when edited, should be differentiated between flight plans

Returns

ProxiedPerformancePlanProperty<P, K>

Overrides

AbstractSubscribable.constructor

Properties

differentiateBetweenFlightPlans

readonly differentiateBetweenFlightPlans: boolean

Defined in: src/sdk/performance/ProxiedPerformancePlanProperty.ts:43

whether the property, when edited, should be differentiated between flight plans

---

initialNotifyFunc()

protected readonly initialNotifyFunc: (sub) => void

Defined in: src/sdk/sub/AbstractSubscribable.ts:26

A function which sends initial notifications to subscriptions.

Notifies a subscription of this subscribable's current state.

Parameters

Parameter	Type	Description
sub	HandlerSubscription<(v) => void>	The subscription to notify.

Returns

void

Inherited from

AbstractSubscribable.initialNotifyFunc

---

isMutableSubscribable

readonly isMutableSubscribable: true = true

Defined in: src/sdk/performance/ProxiedPerformancePlanProperty.ts:27

Flags this object as a MutableSubscribable.

Implementation of

MutableSubscribable.isMutableSubscribable

---

isSubscribable

readonly isSubscribable: true = true

Defined in: src/sdk/performance/ProxiedPerformancePlanProperty.ts:25

Flags this object as a Subscribable.

Implementation of

MutableSubscribable.isSubscribable

Overrides

AbstractSubscribable.isSubscribable

---

key

readonly key: K

Defined in: src/sdk/performance/ProxiedPerformancePlanProperty.ts:42

property key

---

notifyDepth

protected notifyDepth: number = 0

Defined in: src/sdk/sub/AbstractSubscribable.ts:23

Inherited from

AbstractSubscribable.notifyDepth

---

onSubDestroyedFunc()

protected readonly onSubDestroyedFunc: (sub) => void

Defined in: src/sdk/sub/AbstractSubscribable.ts:29

A function which responds to when a subscription to this subscribable is destroyed.

Responds to when a subscription to this subscribable is destroyed.

Parameters

Parameter	Type	Description
sub	HandlerSubscription<(v) => void>	The destroyed subscription.

Returns

void

Inherited from

AbstractSubscribable.onSubDestroyedFunc

---

singletonSub?

protected optional singletonSub: HandlerSubscription<(v) => void>

Defined in: src/sdk/sub/AbstractSubscribable.ts:20

Inherited from

AbstractSubscribable.singletonSub

---

subs?

protected optional subs: HandlerSubscription<(v) => void>[]

Defined in: src/sdk/sub/AbstractSubscribable.ts:22

Inherited from

AbstractSubscribable.subs

Methods

addSubscription()

protected addSubscription(sub): void

Defined in: src/sdk/sub/AbstractSubscribable.ts:35

Adds a subscription to this subscribable.

Parameters

Parameter	Type	Description
sub	HandlerSubscription<(v) => void>	The subscription to add.

Returns

void

Inherited from

AbstractSubscribable.addSubscription

---

get()

get(): ValueType<P, K>

Defined in: src/sdk/performance/ProxiedPerformancePlanProperty.ts:94

Gets this item's state.

Returns

ValueType<P, K>

This item's state.

Implementation of

MutableSubscribable.get

Overrides

AbstractSubscribable.get

---

map()

Call Signature

map<M>(fn, equalityFunc?): MappedSubscribable<M>

Defined in: src/sdk/sub/AbstractSubscribable.ts:186

Maps this subscribable to a new subscribable.

Type Parameters

Type Parameter
M

Parameters

Parameter	Type	Description
fn	(input, previousVal?) => M	The function to use to map to the new subscribable.
equalityFunc?	(a, b) => boolean	The function to use to check for equality between mapped values. Defaults to the strict equality comparison (===).

Returns

MappedSubscribable<M>

The mapped subscribable.

Implementation of

MutableSubscribable.map

Inherited from

AbstractSubscribable.map

Call Signature

map<M>(fn, equalityFunc, mutateFunc, initialVal): MappedSubscribable<M>

Defined in: src/sdk/sub/AbstractSubscribable.ts:195

Maps this subscribable to a new subscribable with a persistent, cached value which is mutated when it changes.

Type Parameters

Type Parameter
M

Parameters

Parameter	Type	Description
fn	(input, previousVal?) => M	The function to use to map to the new subscribable.
equalityFunc	(a, b) => boolean	The function to use to check for equality between mapped values.
mutateFunc	(oldVal, newVal) => void	The function to use to change the value of the mapped subscribable.
initialVal	M	The initial value of the mapped subscribable.

Returns

MappedSubscribable<M>

The mapped subscribable.

Implementation of

MutableSubscribable.map

Inherited from

AbstractSubscribable.map

---

notify()

protected notify(): void

Defined in: src/sdk/sub/AbstractSubscribable.ts:80

Notifies subscriptions that this subscribable's value has changed.

Returns

void

Inherited from

AbstractSubscribable.notify

---

notifySubscription()

protected notifySubscription(sub): void

Defined in: src/sdk/sub/AbstractSubscribable.ts:156

Notifies a subscription of this subscribable's current state.

Parameters

Parameter	Type	Description
sub	HandlerSubscription<(v) => void>	The subscription to notify.

Returns

void

Inherited from

AbstractSubscribable.notifySubscription

---

onSubDestroyed()

protected onSubDestroyed(sub): void

Defined in: src/sdk/sub/AbstractSubscribable.ts:164

Responds to when a subscription to this subscribable is destroyed.

Parameters

Parameter	Type	Description
sub	HandlerSubscription<(v) => void>	The destroyed subscription.

Returns

void

Inherited from

AbstractSubscribable.onSubDestroyed

---

pipe()

Call Signature

pipe(to, paused?): Subscription

Defined in: src/sdk/sub/AbstractSubscribable.ts:219

Subscribes to and pipes this subscribable's state to a mutable subscribable. Whenever an update of this subscribable's state is received through the subscription, it will be used as an input to change the other subscribable's state.

Parameters

Parameter	Type	Description
to	MutableSubscribable<any, ValueType<P, K>>	The mutable subscribable to which to pipe this subscribable's state.
paused?	boolean	Whether the new subscription should be initialized as paused. Defaults to false.

Returns

Subscription

The new subscription.

Implementation of

MutableSubscribable.pipe

Inherited from

AbstractSubscribable.pipe

Call Signature

pipe<M>(to, map, paused?): Subscription

Defined in: src/sdk/sub/AbstractSubscribable.ts:229

Subscribes to this subscribable's state and pipes a mapped version to a mutable subscribable. Whenever an update of this subscribable's state is received through the subscription, it will be transformed by the specified mapping function, and the transformed state will be used as an input to change the other subscribable's state.

Type Parameters

Type Parameter
M

Parameters

Parameter	Type	Description
to	MutableSubscribable<any, M>	The mutable subscribable to which to pipe this subscribable's mapped state.
map	(fromVal, toVal) => M	The function to use to transform inputs.
paused?	boolean	Whether the new subscription should be initialized as paused. Defaults to false.

Returns

Subscription

The new subscription.

Implementation of

MutableSubscribable.pipe

Inherited from

AbstractSubscribable.pipe

---

resetToDefault()

resetToDefault(): void

Defined in: src/sdk/performance/ProxiedPerformancePlanProperty.ts:83

Resets the property to its default value according to the default values performance plan

Returns

void

---

set()

set(value): void

Defined in: src/sdk/performance/ProxiedPerformancePlanProperty.ts:103

Sets the state of this item.

Parameters

Parameter	Type	Description
value	ValueType<P, K>	The input used to change the state.

Returns

void

Implementation of

MutableSubscribable.set

---

sub()

sub(handler, initialNotify?, paused?): Subscription

Defined in: src/sdk/performance/ProxiedPerformancePlanProperty.ts:116

Subscribes to changes in this subscribable's state.

Parameters

Parameter	Type	Description
handler	(value) => void	A function which is called when this subscribable's state changes.
initialNotify?	boolean	Whether to immediately invoke the callback function with this subscribable's current state. Defaults to false. This argument is ignored if the subscription is initialized as paused.
paused?	boolean	Whether the new subscription should be initialized as paused. Defaults to false.

Returns

Subscription

The new subscription.

Implementation of

MutableSubscribable.sub

Overrides

AbstractSubscribable.sub

---

switchToPlan()

switchToPlan(plan): void

Defined in: src/sdk/performance/ProxiedPerformancePlanProperty.ts:55

Switches the target plan

Parameters

Parameter	Type	Description
plan	P	the new target plan

Returns

void

---

unsub()

unsub(handler): void

Defined in: src/sdk/performance/ProxiedPerformancePlanProperty.ts:121

Unsubscribes a callback function from this subscribable.

Parameters

Parameter	Type	Description
handler	(value) => void	The function to unsubscribe.

Returns

void

Deprecated

This method has been deprecated in favor of using the Subscription object returned by .sub() to manage subscriptions.

Implementation of

MutableSubscribable.unsub

Overrides

AbstractSubscribable.unsub

---

DEFAULT_EQUALITY_FUNC()

readonly static DEFAULT_EQUALITY_FUNC(a, b): boolean

Defined in: src/sdk/sub/AbstractSubscribable.ts:18

Checks if two values are equal using the strict equality operator.

Parameters

Parameter	Type	Description
a	any	The first value.
b	any	The second value.

Returns

boolean

whether a and b are equal.

Inherited from

AbstractSubscribable.DEFAULT_EQUALITY_FUNC