Class SignalScope

Hierarchy (View Summary)

ReactiveScope<any[]>
- SignalScope

Constructors

constructor

new SignalScope(): SignalScope
Returns SignalScope
Overrides ReactiveScope<Array<any>>.constructor
- Defined in src/expressions/scope/signal.ts:25

Properties

`Protected`_clone

_clone: any[]

`Protected`_ctx

_ctx: any[]

`Protected`_inners

_inners: Map<keyof any[], ReactiveScope<any>>

`Protected` `Optional`_keys

_keys?: (keyof any[])[]

`Protected` `Optional`_name

_name?: PropertyKey

`Protected`_observer

_observer: ValueChangeObserver<any[]> = ...

`Protected` `Optional`_parent

_parent?: ReactiveScope<any>

Methods

createComputed

createComputed<T>(updateFn: () => T): Computed<T>
Type Parameters
- T
Parameters
- updateFn: () => T
Returns Computed<T>
- Defined in src/expressions/scope/signal.ts:41

createEffect

createEffect(effectFn: (onCleanup?: CleanupFn) => void): SignalDestroyRef
Parameters
- effectFn: (onCleanup?: CleanupFn) => void
Returns SignalDestroyRef
- Defined in src/expressions/scope/signal.ts:65

createLazy

createLazy<T>(updateFn: () => T): Lazy<T>
Type Parameters
- T
Parameters
- updateFn: () => T
Returns Lazy<T>
- Defined in src/expressions/scope/signal.ts:37

createSignal

createSignal<T>(initValue?: T): Signal<T>
Type Parameters
- T
Parameters
- OptionalinitValue: T
Returns Signal<T>
- Defined in src/expressions/scope/signal.ts:33

delete

delete(propertyKey: keyof any[]): boolean
delete property from context
Parameters
- propertyKey: keyof any[]
Returns boolean
Inherited from ReactiveScope.delete
- Defined in src/expressions/scope/scope.ts:296

detectChanges

detectChanges(): void
Returns void
Inherited from ReactiveScope.detectChanges
- Defined in src/expressions/scope/scope.ts:320

emit

emit(propertyKey: keyof any[], newValue: any, oldValue?: any): void
Parameters
- propertyKey: keyof any[]
- newValue: any
- OptionaloldValue: any
Returns void
Inherited from ReactiveScope.emit
- Defined in src/expressions/scope/scope.ts:304

get

get(propertyKey: keyof any[]): any
get value of propertyKey in current context
Parameters
- propertyKey: keyof any[]
Returns any
Inherited from Scope.get
- Defined in src/expressions/scope/scope.ts:11
get(key: keyof any[]): any
get value of propertyKey in current context
Parameters
- key: keyof any[]
Returns any
Inherited from Scope.get
- Defined in src/expressions/scope/scope.ts:78

getClass

getClass(): TypeOf<ReactiveScope<Context>>
Returns TypeOf<ReactiveScope<Context>>
Inherited from ReactiveScope.getClass
- Defined in src/expressions/scope/scope.ts:366

getContext

getContext(): any[]
get current context object of this scope

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

Returns any[]
Inherited from Scope.getContext
- Defined in src/expressions/scope/scope.ts:90

`Optional`getContextProxy

getContextProxy?(): any[]
get a proxy of the current context object if exists.

Returns any[]
Inherited from Scope.getContextProxy
- Defined in src/expressions/scope/scope.ts:41

getInnerScope

getInnerScope<S extends Scope<Context>>(propertyKey: keyof any[]): S | undefined
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<Context>
Parameters
- propertyKey: keyof any[]
  the name of the property
Returns S | undefined
Inherited from Scope.getInnerScope
- Defined in src/expressions/scope/scope.ts:49
getInnerScope<S extends Scope<Context>>(key: keyof any[]): S | undefined
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<Context>
Parameters
- key: keyof any[]
Returns S | undefined
Inherited from Scope.getInnerScope
- Defined in src/expressions/scope/scope.ts:93

getNextKey

getNextKey(): number
Returns number
- Defined in src/expressions/scope/signal.ts:29

`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 src/expressions/scope/scope.ts:347

has

has(propertyKey: keyof any[]): boolean
is current context has propertyKey in hash map keys
Parameters
- propertyKey: keyof any[]
Returns boolean
Inherited from Scope.has
- Defined in src/expressions/scope/scope.ts:25
has(key: keyof any[]): boolean
is current context has propertyKey in hash map keys
Parameters
- key: keyof any[]
Returns boolean
Inherited from Scope.has
- Defined in src/expressions/scope/scope.ts:84

observeIndex

observeIndex(index: number): void
Parameters
- index: number
Returns void
- Defined in src/expressions/scope/signal.ts:116

observeState

observeState(updateFn: () => void): { [k: string]: ScopeSubscription<any[]> }
Parameters
- updateFn: () => void
Returns { [k: string]: ScopeSubscription<any[]> }
- Defined in src/expressions/scope/signal.ts:130

readState

readState(): number[]
Returns number[]
- Defined in src/expressions/scope/signal.ts:126

restoreState

restoreState(): void
Returns void
- Defined in src/expressions/scope/signal.ts:134

set

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

setInnerScope

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

subscribe(
propertyKey: keyof any[],
callback: ValueChangedCallback,
): ScopeSubscription<any[]>
Parameters
- propertyKey: keyof any[]
- callback: ValueChangedCallback
Returns ScopeSubscription<any[]>
Inherited from ReactiveScope.subscribe
- Defined in src/expressions/scope/scope.ts:308

track

track(): void
Returns void
- Defined in src/expressions/scope/signal.ts:122

unsubscribe

unsubscribe(
propertyKey?: keyof any[],
subscription?: ScopeSubscription<any[]>,
): void
Parameters
- OptionalpropertyKey: keyof any[]
- Optionalsubscription: ScopeSubscription<any[]>
Returns void
Inherited from ReactiveScope.unsubscribe
- Defined in src/expressions/scope/scope.ts:311

untrack

untrack(): void
Returns void
- Defined in src/expressions/scope/signal.ts:112

watchState

watchState(): void
Returns void
- Defined in src/expressions/scope/signal.ts:108

`Static`blockScope

blockScope<T extends Context>(propertyKeys?: (keyof T)[]): ReactiveScope<T>
Type Parameters
- T extends Context
Parameters
- OptionalpropertyKeys: (keyof T)[]
Returns ReactiveScope<T>
Inherited from ReactiveScope.blockScope
- Defined in src/expressions/scope/scope.ts:246

`Static`create

create(): SignalScope
Returns SignalScope
- Defined in src/expressions/scope/signal.ts:18

`Static`for

for<T extends Context>(context: T, propertyKeys?: (keyof T)[]): ReactiveScope<T>
Type Parameters
- T extends Context
Parameters
- context: T
- OptionalpropertyKeys: (keyof T)[]
Returns ReactiveScope<T>
Inherited from ReactiveScope.for
- Defined in src/expressions/scope/scope.ts:243

`Static`readOnlyScopeForAliasThis

readOnlyScopeForAliasThis<T extends Context>(
ctx: T,
alias: string,
): ReadOnlyScope<{ this: T; [key: string]: T }>
Type Parameters
- T extends Context
Parameters
- ctx: T
- alias: string
Returns ReadOnlyScope<{ this: T; [key: string]: T }>
Inherited from ReactiveScope.readOnlyScopeForAliasThis
- Defined in src/expressions/scope/scope.ts:267

`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 }>
Inherited from ReactiveScope.readOnlyScopeForThis
- Defined in src/expressions/scope/scope.ts:258

`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 }>
Inherited from ReactiveScope.scopeForThis
- Defined in src/expressions/scope/scope.ts:249

Class SignalScope

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns SignalScope

Properties

Protected_clone

Protected_ctx

Protected_inners

Protected Optional_keys

Protected Optional_name

Protected_observer

Protected Optional_parent

Methods

createComputed

Type Parameters

Parameters

Returns Computed<T>

createEffect

Parameters

Returns SignalDestroyRef

createLazy

Type Parameters

Parameters

Returns Lazy<T>

createSignal

Type Parameters

Parameters

Returns Signal<T>

delete

Parameters

Returns boolean

detectChanges

Returns void

emit

Parameters

Returns void

get

Parameters

Returns any

Parameters

Returns any

getClass

Returns TypeOf<ReactiveScope<Context>>

getContext

Returns any[]

Returns any[]

OptionalgetContextProxy

Returns any[]

getInnerScope

Type Parameters

Parameters

Returns S | undefined

Type Parameters

Parameters

Returns S | undefined

getNextKey

Returns number

ProtectedgetPropertyKeys

Type Parameters

Parameters

Returns (keyof V)[]

has

Parameters

Returns boolean

Parameters

Returns boolean

observeIndex

Parameters

Returns void

observeState

Parameters

Returns { [k: string]: ScopeSubscription<any[]> }

readState

Returns number[]

restoreState

`Protected`_clone

`Protected`_ctx

`Protected`_inners

`Protected` `Optional`_keys

`Protected` `Optional`_name

`Protected`_observer

`Protected` `Optional`_parent

`Optional`getContextProxy

`Protected`getPropertyKeys

`Static`blockScope

`Static`create

`Static`for

`Static`readOnlyScopeForAliasThis

`Static`readOnlyScopeForThis

`Static`scopeForThis