Class LinkableSignal<GValue>

A WritableSignal whose state may be linked with another Signal.

Type Parameters

GValue

Hierarchy (View Summary)

Transient
- LinkableSignal
  - LinkableSignalWithPolling

Implements

LinkableSignalTrait<GValue>

Index

Constructors

constructor

new LinkableSignal<GValue>(
initialValue: SignalValueOrError<GValue>,
options?: LinkableSignalOptions<GValue>,
): LinkableSignal<GValue>
Type Parameters
- GValue
Parameters
- initialValue: SignalValueOrError<GValue>
- Optionaloptions: LinkableSignalOptions<GValue>
Returns LinkableSignal<GValue>
Overrides Transient.constructor
- Defined in src/transients/extension.protected/linkable-signal/linkable-signal.ts:39

Accessors

linked

get linked(): boolean
Returns boolean
See
LinkableSignalLinkedTrait
Implementation of LinkableSignalTrait.linked
- Defined in src/transients/extension.protected/linkable-signal/linkable-signal.ts:127

locked

get locked(): boolean
Returns boolean
See
LinkableSignalLockedTrait
Implementation of LinkableSignalTrait.locked
- Defined in src/transients/extension.protected/linkable-signal/linkable-signal.ts:134

Methods

asReadonly

asReadonly(): ReadonlySignal<GValue>
Returns ReadonlySignal<GValue>
See
WritableSignalAsReadonlyTrait
Implementation of LinkableSignalTrait.asReadonly
- Defined in src/transients/extension.protected/linkable-signal/linkable-signal.ts:120

capture

capture(): void
Returns void
See
TransientCaptureTrait
Implementation of LinkableSignalTrait.capture
Inherited from Transient.capture
- Defined in src/transients/core/transient/transient.ts:56

get

get(): GValue
Returns GValue
See
SignalGetTrait
Implementation of LinkableSignalTrait.get
- Defined in src/transients/extension.protected/linkable-signal/linkable-signal.ts:82

link

link(
signal: SignalTrait<GValue>,
__namedParameters?: LinkableSignalLinkOptions,
): UndoFunction
Parameters
- signal: SignalTrait<GValue>
- __namedParameters: LinkableSignalLinkOptions = {}
Returns UndoFunction
See
LinkableSignalLinkTrait
Implementation of LinkableSignalTrait.link
- Defined in src/transients/extension.protected/linkable-signal/linkable-signal.ts:141

set

set(value: SignalValueOrError<GValue>): void
Parameters
- value: SignalValueOrError<GValue>
Returns void
See
WritableSignalSetTrait
Implementation of LinkableSignalTrait.set
- Defined in src/transients/extension.protected/linkable-signal/linkable-signal.ts:89

takeSnapshot

takeSnapshot(): TransientSnapshotChanged
Returns TransientSnapshotChanged
See
TransientTakeSnapshotTrait
Implementation of LinkableSignalTrait.takeSnapshot
Overrides Transient.takeSnapshot
- Defined in src/transients/extension.protected/linkable-signal/linkable-signal.ts:68

throw

throw(error: unknown): void
Parameters
- error: unknown
Returns void
See
WritableSignalThrowTrait
Implementation of LinkableSignalTrait.throw
- Defined in src/transients/extension.protected/linkable-signal/linkable-signal.ts:97

trackActivity

trackActivity(onActivity: TransientActivity): UndoFunction
Parameters
- onActivity: TransientActivity
Returns UndoFunction
See
TransientTrackActivityTrait
Implementation of LinkableSignalTrait.trackActivity
Overrides Transient.trackActivity
- Defined in src/transients/extension.protected/linkable-signal/linkable-signal.ts:75

unlink

unlink(): void
Returns void
See
LinkableSignalUnlinkTrait
Implementation of LinkableSignalTrait.unlink
- Defined in src/transients/extension.protected/linkable-signal/linkable-signal.ts:174

update

update(updateFunction: SignalUpdateFunctionCallback<GValue>): void
Parameters
- updateFunction: SignalUpdateFunctionCallback<GValue>
Returns void
See
WritableSignalUpdateTrait
Implementation of LinkableSignalTrait.update
- Defined in src/transients/extension.protected/linkable-signal/linkable-signal.ts:104

`Static`isInContext

isInContext(): boolean
Returns true if we are currently inside a "Transient context".

Returns boolean
Inherited from Transient.isInContext
- Defined in src/transients/core/transient/transient.ts:39

`Static`runInContext

runInContext<GReturn>(
captureTransient: undefined | CaptureTransient,
callback: () => GReturn,
): GReturn
Runs a callback in witch any Transient captured synchronously through transient.capture() is provided to the function captureTransient.
Type Parameters
- GReturn
Parameters
- captureTransient: undefined | CaptureTransient
- callback: () => GReturn
Returns GReturn
Inherited from Transient.runInContext
- Defined in src/transients/core/transient/transient.ts:16

`Static`runOutsideContext

runOutsideContext<GReturn>(callback: () => GReturn): GReturn
Ignores any transient.capture() present in the context of callback.
Type Parameters
- GReturn
Parameters
- callback: () => GReturn
Returns GReturn
Inherited from Transient.runOutsideContext
- Defined in src/transients/core/transient/transient.ts:32

`Static`thrown

thrown<GValue>(
error: unknown,
options?: LinkableSignalOptions<GValue>,
): LinkableSignal<GValue>
Type Parameters
- GValue
Parameters
- error: unknown
- Optionaloptions: LinkableSignalOptions<GValue>
Returns LinkableSignal<GValue>
- Defined in src/transients/extension.protected/linkable-signal/linkable-signal.ts:25

`Static`unset

unset<GValue>(options?: LinkableSignalOptions<GValue>): LinkableSignal<GValue>
Type Parameters
- GValue
Parameters
- Optionaloptions: LinkableSignalOptions<GValue>
Returns LinkableSignal<GValue>
- Defined in src/transients/extension.protected/linkable-signal/linkable-signal.ts:21

Class LinkableSignal<GValue>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns LinkableSignal<GValue>

Accessors

linked

Returns boolean

See

locked

Returns boolean

See

Methods

asReadonly

Returns ReadonlySignal<GValue>

See

capture

Returns void

See

get

Returns GValue

See

link

Parameters

Returns UndoFunction

See

set

Parameters

Returns void

See

takeSnapshot

Returns TransientSnapshotChanged

See

throw

Parameters

Returns void

See

trackActivity

Parameters

Returns UndoFunction

See

unlink

Returns void

See

update

Parameters

Returns void

See

StaticisInContext

Returns boolean

StaticrunInContext

Type Parameters

Parameters

Returns GReturn

StaticrunOutsideContext

Type Parameters

Parameters

Returns GReturn

Staticthrown

Type Parameters

Parameters

Returns LinkableSignal<GValue>

Staticunset

Type Parameters

Parameters

Returns LinkableSignal<GValue>

Settings

On This Page

`Static`isInContext

`Static`runInContext

`Static`runOutsideContext

`Static`thrown

`Static`unset