Class BaseSignal<T>`Abstract`

Abstract base class for signal implementations managing the callability of the signal object and internal management of the signal value including the observability of it through in internally created shared observable.

Type Parameters

T = unknown

Hierarchy (View Summary)

Callable<[], T>
- BaseSignal

Implements

CallableSignal<T>

BaseSignal(): T
Returns T
- Defined in BaseSignal.ts:22
BaseSignal(...args: []): T
Parameters
- ...args: []
Returns T
- Defined in BaseSignal.ts:21
- Defined in BaseSignal.ts:29

Index

Constructors

Methods

get isObserved set subscribe

Constructors

constructor

new BaseSignal<T = unknown>(
initialValue: T,
options?: BaseSignalOptions<T>,
): BaseSignal<T>
Creates a new signal with the given initial value and options.
Type Parameters
- T = unknown
Parameters
- initialValue: T
  The initial signal value.
- options: BaseSignalOptions<T> = {}
  The base signal options.
Returns BaseSignal<T>
- Defined in BaseSignal.ts:41

Methods

get

get(): T
Returns T
The current signal value.
- Defined in BaseSignal.ts:54

`Protected`isObserved

isObserved(): boolean
Returns boolean
True if signal is observed (has subscribed observers) or false if not.
- Defined in BaseSignal.ts:82

`Protected`set

set(value: T): this
Sets the value.
Parameters
- value: T
  The value to set.
Returns this
- Defined in BaseSignal.ts:64

subscribe

subscribe(
    ...args:
        | [Observer<T>]
        | [
            (value: T) => void,
            error?: (error: Error) => void,
            complete?: () => void,
        ],
): Unsubscribable
Parameters
- ...args:
      | [Observer<T>]
      | [
          (value: T) => void,
          error?: (error: Error) => void,
          complete?: () => void,
      ]
Returns Unsubscribable
Inherit Doc
- Defined in BaseSignal.ts:73