Class ReactiveControlScope<T>

Type Parameters

T extends Context

Hierarchy (View Summary)

ReactiveScope<T>
- ReactiveControlScope

Implements

ControlScope<T>

Constructors

constructor

new ReactiveControlScope<T extends Context>(
    context: T,
    propertyKeys?: (keyof T)[],
    _name?: PropertyKey,
    _parent?: ReactiveScope<any>,
): ReactiveControlScope<T>
Type Parameters
- T extends Context
Parameters
- context: T
- OptionalpropertyKeys: (keyof T)[]
- Optional_name: PropertyKey
- Optional_parent: ReactiveScope<any>
Returns ReactiveControlScope<T>
Inherited from ReactiveScope<T>.constructor
- Defined in git/aurora/src/expressions/scope/scope.ts:272

Properties

`Protected`_attached

_attached: boolean = true

`Protected`_clone

_clone: T

`Protected`_ctx

_ctx: T

`Protected`_inners

_inners: Map<keyof T, ReactiveScope<any>>

`Protected` `Optional`_keys

_keys?: (keyof T)[]

`Protected`_marked

_marked: { [key: string | number | symbol]: [any, any] } = {}

`Protected` `Optional`_name

_name?: PropertyKey

`Protected`_observer

_observer: ValueChangeObserver<T> = ...

`Protected` `Optional`_parent

_parent?: ReactiveScope<any>

Methods

checkNoChanges

checkNoChanges(): void
throw error if any changes has been made

Returns void
Implementation of ControlScope.checkNoChanges
- Defined in git/aurora/src/expressions/scope/scope.ts:476

delete

delete(propertyKey: keyof T): boolean
delete property from context
Parameters
- propertyKey: keyof T
Returns boolean
Inherited from ReactiveScope.delete
- Defined in git/aurora/src/expressions/scope/scope.ts:285

detach

detach(): void
used when want to update ui-view like, you want to replace an array with another without reflect changes on view until reattached again.

Returns void
Implementation of ControlScope.detach
- Defined in git/aurora/src/expressions/scope/scope.ts:450

detectChanges

detectChanges(): void
Returns void
Overrides ReactiveScope.detectChanges
- Defined in git/aurora/src/expressions/scope/scope.ts:471

emit

emit(propertyKey: keyof T, newValue: any, oldValue?: any): void
Parameters
- propertyKey: keyof T
- newValue: any
- OptionaloldValue: any
Returns void
Overrides ReactiveScope.emit
- Defined in git/aurora/src/expressions/scope/scope.ts:434

emitChanges

emitChanges(propertyKey?: keyof T, propertyValue?: any): void
apply changes now, will not effect the state of the detector wither if attached ot not.

if a propertyKey is provided, will emit this property only
Parameters
- OptionalpropertyKey: keyof T
- OptionalpropertyValue: any
Returns void
Implementation of ControlScope.emitChanges
- Defined in git/aurora/src/expressions/scope/scope.ts:457

get

get(propertyKey: keyof T): any
get value of propertyKey in current context
Parameters
- propertyKey: keyof T
Returns any
Inherited from ReactiveScope.get
- Defined in git/aurora/src/expressions/scope/scope.ts:11
get(key: keyof T): any
get value of propertyKey in current context
Parameters
- key: keyof T
Returns any
Inherited from ReactiveScope.get
- Defined in git/aurora/src/expressions/scope/scope.ts:78

getClass

getClass(): TypeOf<ReactiveControlScope<Context>>
Returns TypeOf<ReactiveControlScope<Context>>
Overrides ReactiveScope.getClass
- Defined in git/aurora/src/expressions/scope/scope.ts:484

getContext

getContext(): T
get current context object of this scope

Returns T
Inherited from ReactiveScope.getContext
- Defined in git/aurora/src/expressions/scope/scope.ts:36
getContext(): T
get current context object of this scope

Returns T
Inherited from ReactiveScope.getContext
- Defined in git/aurora/src/expressions/scope/scope.ts:90

`Optional`getContextProxy

getContextProxy(): T
get a proxy of the current context object if exists.

Returns T
Inherited from ReactiveScope.getContextProxy
- Defined in git/aurora/src/expressions/scope/scope.ts:41

getInnerScope

getInnerScope<S extends Scope>(propertyKey: keyof T): undefined | S
get a scope for an object named as propertyKey from cache map,

if the current value is not type od object, will return undefined.
Type Parameters
- S extends Scope
Parameters
- propertyKey: keyof T
  the name of the property
Returns undefined | S
Inherited from ReactiveScope.getInnerScope
- Defined in git/aurora/src/expressions/scope/scope.ts:49
getInnerScope<S extends Scope>(key: keyof T): undefined | S
get a scope for an object named as propertyKey from cache map,

if the current value is not type od object, will return undefined.
Type Parameters
- S extends Scope
Parameters
- key: keyof T
Returns undefined | S
Inherited from ReactiveScope.getInnerScope
- Defined in git/aurora/src/expressions/scope/scope.ts:93

`Protected`getPropertyKeys

getPropertyKeys<V extends Record<PropertyKey, any>>(...objs: V[]): (keyof V)[]
Type Parameters
- V extends Record<PropertyKey, any>
Parameters
- ...objs: V[]
Returns (keyof V)[]
Inherited from ReactiveScope.getPropertyKeys
- Defined in git/aurora/src/expressions/scope/scope.ts:336

has

has(propertyKey: keyof T): boolean
is current context has propertyKey in hash map keys
Parameters
- propertyKey: keyof T
Returns boolean
Inherited from ReactiveScope.has
- Defined in git/aurora/src/expressions/scope/scope.ts:25
has(key: keyof T): boolean
is current context has propertyKey in hash map keys
Parameters
- key: keyof T
Returns boolean
Inherited from ReactiveScope.has
- Defined in git/aurora/src/expressions/scope/scope.ts:84

isAttached

isAttached(): boolean
get current stacte of applying change detection.

Returns boolean
Implementation of ControlScope.isAttached
- Defined in git/aurora/src/expressions/scope/scope.ts:447

reattach

reattach(): void
apply all the not emitted changes, and continue emit in time.

Returns void
Implementation of ControlScope.reattach
- Defined in git/aurora/src/expressions/scope/scope.ts:453

set

set(propertyKey: keyof T, newValue: any, receiver?: any): boolean
set the value of propertyKey in current context, could be instilled with value.
Parameters
- propertyKey: keyof T
- newValue: any
- Optionalreceiver: any
Returns boolean
Inherited from ReactiveScope.set
- Defined in git/aurora/src/expressions/scope/scope.ts:277

setInnerScope

setInnerScope<S extends Scope>(propertyKey: keyof T): S
create a scope with the same type of this scope
Type Parameters
- S extends Scope
Parameters
- propertyKey: keyof T
Returns S
Inherited from ReactiveScope.setInnerScope
- Defined in git/aurora/src/expressions/scope/scope.ts:54
setInnerScope<S extends Scope>(propertyKey: keyof T, scope?: S): S
sc
Type Parameters
- S extends Scope
Parameters
- propertyKey: keyof T
- Optionalscope: S
Returns S
Inherited from ReactiveScope.setInnerScope
- Defined in git/aurora/src/expressions/scope/scope.ts:61
setInnerScope<S extends Scope>(key: keyof T, scope?: S): S
create a scope with the same type of this scope
Type Parameters
- S extends Scope
Parameters
- key: keyof T
- Optionalscope: S
Returns S
Inherited from ReactiveScope.setInnerScope
- Defined in git/aurora/src/expressions/scope/scope.ts:107

subscribe(
propertyKey: keyof T,
callback: ValueChangedCallback,
): ScopeSubscription<T>
Parameters
- propertyKey: keyof T
- callback: ValueChangedCallback
Returns ScopeSubscription<T>
Inherited from ReactiveScope.subscribe
- Defined in git/aurora/src/expressions/scope/scope.ts:297

unsubscribe

unsubscribe(propertyKey?: keyof T, subscription?: ScopeSubscription<T>): void
Parameters
- OptionalpropertyKey: keyof T
- Optionalsubscription: ScopeSubscription<T>
Returns void
Inherited from ReactiveScope.unsubscribe
- Defined in git/aurora/src/expressions/scope/scope.ts:300

`Static`blockScope

blockScope<T extends Context>(
propertyKeys?: (keyof T)[],
): ReactiveControlScope<T>
Type Parameters
- T extends Context
Parameters
- OptionalpropertyKeys: (keyof T)[]
Returns ReactiveControlScope<T>
Overrides ReactiveScope.blockScope
- Defined in git/aurora/src/expressions/scope/scope.ts:400

`Static`for

for<T extends Context>(
context: T,
propertyKeys?: (keyof T)[],
): ReactiveControlScope<T>
Type Parameters
- T extends Context
Parameters
- context: T
- OptionalpropertyKeys: (keyof T)[]
Returns ReactiveControlScope<T>
Overrides ReactiveScope.for
- Defined in git/aurora/src/expressions/scope/scope.ts:397

`Static`reactiveScopeForThis

reactiveScopeForThis<T extends Context>(
ctx: T,
propertyKeys?: (keyof T)[],
): Scope<{ this: T }>
Type Parameters
- T extends Context
Parameters
- ctx: T
- OptionalpropertyKeys: (keyof T)[]
Returns Scope<{ this: T }>
- Defined in git/aurora/src/expressions/scope/scope.ts:421

`Static`readOnlyScopeForThis

readOnlyScopeForThis<T extends Context>(
ctx: T,
propertyKeys?: (keyof T)[],
): ReadOnlyScope<{ this: T }>
Type Parameters
- T extends Context
Parameters
- ctx: T
- OptionalpropertyKeys: (keyof T)[]
Returns ReadOnlyScope<{ this: T }>
Overrides ReactiveScope.readOnlyScopeForThis
- Defined in git/aurora/src/expressions/scope/scope.ts:412

`Static`scopeForThis

scopeForThis<T extends Context>(
ctx: T,
propertyKeys?: (keyof T)[],
): Scope<{ this: T }>
Type Parameters
- T extends Context
Parameters
- ctx: T
- OptionalpropertyKeys: (keyof T)[]
Returns Scope<{ this: T }>
Overrides ReactiveScope.scopeForThis
- Defined in git/aurora/src/expressions/scope/scope.ts:403

Class ReactiveControlScope<T>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ReactiveControlScope<T>

Properties

Protected_attached

Protected_clone

Protected_ctx

Protected_inners

Protected Optional_keys

Protected_marked

Protected Optional_name

Protected_observer

Protected Optional_parent

Methods

checkNoChanges

Returns void

delete

Parameters

Returns boolean

detach

Returns void

detectChanges

Returns void

emit

Parameters

Returns void

emitChanges

Parameters

Returns void

get

Parameters

Returns any

Parameters

Returns any

getClass

Returns TypeOf<ReactiveControlScope<Context>>

getContext

Returns T

Returns T

OptionalgetContextProxy

Returns T

getInnerScope

Type Parameters

Parameters

Returns undefined | S

Type Parameters

Parameters

Returns undefined | S

ProtectedgetPropertyKeys

Type Parameters

Parameters

Returns (keyof V)[]

has

Parameters

Returns boolean

Parameters

Returns boolean

isAttached

Returns boolean

reattach

Returns void

set

Parameters

Returns boolean

setInnerScope

Type Parameters

Parameters

Returns S

Type Parameters

Parameters

`Protected`_attached

`Protected`_clone

`Protected`_ctx

`Protected`_inners

`Protected` `Optional`_keys

`Protected`_marked

`Protected` `Optional`_name

`Protected`_observer

`Protected` `Optional`_parent

`Optional`getContextProxy

`Protected`getPropertyKeys

`Static`blockScope

`Static`for

`Static`reactiveScopeForThis

`Static`readOnlyScopeForThis

`Static`scopeForThis