Class SignalScope

Hierarchy (View Summary)

Constructors

constructor

Properties

_clone _ctx _inners _keys? _name? _observer _parent?

Methods

createComputed createEffect createLazy createSignal delete detectChanges emit get getClass getContext getContextProxy? getInnerScope getNextKey getPropertyKeys has observeIndex observeState readState restoreState set setInnerScope subscribe track unsubscribe untrack watchState blockScope create for readOnlyScopeForThis scopeForThis

Constructors

constructor

  • new SignalScope(): SignalScope

  • Returns SignalScope

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>

createEffect

createLazy

  • createLazy<T>(updateFn: () => T): Lazy<T>

  • Type Parameters

    • T

    Parameters

    • updateFn: () => T

    Returns Lazy<T>

createSignal

  • createSignal<T>(initValue?: T): Signal<T>

  • Type Parameters

    • T

    Parameters

    • OptionalinitValue: T

    Returns Signal<T>

delete

  • delete(propertyKey: keyof any[]): boolean

  • delete property from context

    Parameters

    • propertyKey: keyof any[]

    Returns boolean

detectChanges

  • detectChanges(): void

  • Returns void

emit

  • emit(propertyKey: keyof any[], newValue: any, oldValue?: any): void

  • Parameters

    • propertyKey: keyof any[]
    • newValue: any
    • OptionaloldValue: any

    Returns void

get

  • get(propertyKey: keyof any[]): any

  • get value of propertyKey in current context

    Parameters

    • propertyKey: keyof any[]

    Returns any

getClass

getContext

  • getContext(): any[]

  • get current context object of this scope

    Returns any[]

OptionalgetContextProxy

  • getContextProxy(): any[]

  • get a proxy of the current context object if exists.

    Returns any[]

getInnerScope

  • getInnerScope<S extends Scope>(propertyKey: keyof any[]): 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

    Parameters

    • propertyKey: keyof any[]

      the name of the property

    Returns undefined | S

getNextKey

  • getNextKey(): number

  • Returns number

ProtectedgetPropertyKeys

  • getPropertyKeys<V extends Record<PropertyKey, any>>(...objs: V[]): (keyof V)[]

  • Type Parameters

    • V extends Record<PropertyKey, any>

    Parameters

    • ...objs: V[]

    Returns (keyof V)[]

has

  • has(propertyKey: keyof any[]): boolean

  • is current context has propertyKey in hash map keys

    Parameters

    • propertyKey: keyof any[]

    Returns boolean

observeIndex

  • observeIndex(index: number): void

  • Parameters

    • index: number

    Returns void

observeState

  • observeState(updateFn: () => void): { [k: string]: ScopeSubscription<any[]> }

  • Parameters

    • updateFn: () => void

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

readState

  • readState(): number[]

  • Returns number[]

restoreState

  • restoreState(): void

  • Returns void

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

setInnerScope

  • setInnerScope<S extends Scope>(propertyKey: keyof any[]): S

  • create a scope with the same type of this scope

    Type Parameters

    Parameters

    • propertyKey: keyof any[]

    Returns S

  • setInnerScope<S extends Scope>(propertyKey: keyof any[], scope?: S): S

  • sc

    Type Parameters

    Parameters

    • propertyKey: keyof any[]
    • Optionalscope: S

    Returns S

subscribe

track

  • track(): void

  • Returns void

unsubscribe

  • unsubscribe(
        propertyKey?: keyof any[],
        subscription?: ScopeSubscription<any[]>,
    ): void

  • Parameters

    Returns void

untrack

  • untrack(): void

  • Returns void

watchState

  • watchState(): void

  • Returns void

StaticblockScope

  • blockScope<T extends Context>(propertyKeys?: (keyof T)[]): ReactiveScope<T>

  • Type Parameters

    Parameters

    • OptionalpropertyKeys: (keyof T)[]

    Returns ReactiveScope<T>

Staticcreate

Staticfor

  • for<T extends Context>(context: T, propertyKeys?: (keyof T)[]): ReactiveScope<T>

  • Type Parameters

    Parameters

    • context: T
    • OptionalpropertyKeys: (keyof T)[]

    Returns ReactiveScope<T>

StaticreadOnlyScopeForThis

  • readOnlyScopeForThis<T extends Context>(
        ctx: T,
        propertyKeys?: (keyof T)[],
    ): ReadOnlyScope<{ this: T }>

  • Type Parameters

    Parameters

    • ctx: T
    • OptionalpropertyKeys: (keyof T)[]

    Returns ReadOnlyScope<{ this: T }>

StaticscopeForThis

  • scopeForThis<T extends Context>(
        ctx: T,
        propertyKeys?: (keyof T)[],
    ): Scope<{ this: T }>

  • Type Parameters

    Parameters

    • ctx: T
    • OptionalpropertyKeys: (keyof T)[]

    Returns Scope<{ this: T }>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods