Class ReadOnlyScope<T>

Type Parameters

T extends Context

Hierarchy (View Summary)

Scope<T>
- ReadOnlyScope

Index

Constructors

constructor

new ReadOnlyScope<T extends Context>(
context: T,
propertyKeys?: (keyof T)[],
): ReadOnlyScope<T>
Type Parameters
- T extends Context
Parameters
- context: T
- OptionalpropertyKeys: (keyof T)[]
Returns ReadOnlyScope<T>
Inherited from Scope<T>.constructor
- Defined in git/aurora/src/expressions/scope/scope.ts:76

Properties

`Protected`_ctx

_ctx: T

`Protected`_inners

_inners: Map<keyof T, Scope<any>> = ...

`Protected` `Optional`_keys

_keys?: (keyof T)[]

Methods

delete

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

get

get(propertyKey: keyof T): any
get value of propertyKey in current context
Parameters
- propertyKey: keyof T
Returns any
Inherited from Scope.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 Scope.get
- Defined in git/aurora/src/expressions/scope/scope.ts:78

getClass

getClass(): TypeOf<ReadOnlyScope<Context>>
Returns TypeOf<ReadOnlyScope<Context>>
Overrides Scope.getClass
- Defined in git/aurora/src/expressions/scope/scope.ts:137

getContext

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

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

Returns T
Inherited from Scope.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 Scope.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 Scope.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 Scope.getInnerScope
- Defined in git/aurora/src/expressions/scope/scope.ts:93

has

has(propertyKey: keyof T): boolean
is current context has propertyKey in hash map keys
Parameters
- propertyKey: keyof T
Returns boolean
Inherited from Scope.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 Scope.has
- Defined in git/aurora/src/expressions/scope/scope.ts:84

set

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

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 Scope.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 Scope.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 Scope.setInnerScope
- Defined in git/aurora/src/expressions/scope/scope.ts:107

`Static`blockScope

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

`Static`for

for<T extends Context>(ctx: T, propertyKeys?: (keyof T)[]): ReadOnlyScope<T>
Type Parameters
- T extends Context
Parameters
- ctx: T
- OptionalpropertyKeys: (keyof T)[]
Returns ReadOnlyScope<T>
Overrides Scope.for
- Defined in git/aurora/src/expressions/scope/scope.ts:123

Class ReadOnlyScope<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ReadOnlyScope<T>

Properties

Protected_ctx

Protected_inners

Protected Optional_keys

Methods

delete

Parameters

Returns boolean

get

Parameters

Returns any

Parameters

Returns any

getClass

Returns TypeOf<ReadOnlyScope<Context>>

getContext

Returns T

Returns T

OptionalgetContextProxy

Returns T

getInnerScope

Type Parameters

Parameters

Returns undefined | S

Type Parameters

Parameters

Returns undefined | S

has

Parameters

Returns boolean

Parameters

Returns boolean

set

Parameters

Returns boolean

setInnerScope

Type Parameters

Parameters

Returns S

Type Parameters

Parameters

Returns S

Type Parameters

Parameters

Returns S

StaticblockScope

Type Parameters

Parameters

Returns ReadOnlyScope<T>

Staticfor

Type Parameters

Parameters

Returns ReadOnlyScope<T>

Settings

On This Page

`Protected`_ctx

`Protected`_inners

`Protected` `Optional`_keys

`Optional`getContextProxy

`Static`blockScope

`Static`for