ReadonlySignal<T> class
abstract
Read only signals can just retrieve a value but not update or cause mutations
- Mixed-in types
- Available extensions
Constructors
Properties
- autoDispose ↔ bool
-
Throws and error if read after dispose and can be
disposed on last unsubscribe.
getter/setter pairinherited
- brand → Symbol
-
finalinherited
- debugLabel → String?
-
Debug label for Debug Mode
no setterinherited
- disposed ↔ bool
-
Check if the effect is disposed
getter/setter pairinherited
- globalId → int
-
Global ID of the signal
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- internalValue → T
-
no setterinherited
- isInitialized → bool
-
Check if a signal value is set (does not subscribe)
no setterinherited
- node ↔ Node?
-
getter/setter pairinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- targets ↔ Node?
-
getter/setter pairinherited
- untrackedValue → T
-
Available on ReadonlySignal<
Runs a callback function that returns the signal value without subscribing to the signal updates.T> , provided by the ReadonlySignalUntrackedValueUtils extensionno setter - value → T
-
Compute the current value
no setterinherited
- version → int
-
Version numbers should always be >= 0, because the special value -1 is used
by Nodes to signify potentially unused but recyclable nodes.
no setterinherited
Methods
-
afterCreate(
T val) → void -
Internal hook for after a signal is created
inherited
-
beforeUpdate(
T val) → void -
Internal hook for after a signal is updated
inherited
-
call(
) → T -
Return the value when invoked
inherited
-
dispose(
) → void -
Dispose the signal
inherited
-
get(
) → T -
Helper method to get the current value
inherited
-
internalRefresh(
) → bool -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onDispose(
void cleanup()) → EffectCleanup -
Add a cleanup function to be called when the signal is disposed
inherited
-
peek(
) → T -
In the rare instance that you have an effect that should write to another signal based on the previous value, but you don't want the effect to be subscribed to that signal, you can read a signals's previous value via
signal.peek().inherited -
select<
R> (R selector(ReadonlySignal< T> ), {bool autoDispose = false, String? debugLabel}) → Computed<R> -
Available on ReadonlySignal<
Select a value and return a computed signal to listen for changesT> , provided by the ReadonlySignalUtils extension -
subscribe(
void fn(T value)) → void Function() -
Subscribe to value changes with a dispose function
inherited
-
subscribeToNode(
Node node) → void -
inherited
-
toJson(
) → dynamic -
Convert value to JSON
inherited
-
toStream(
) → Stream< T> -
Available on ReadonlySignal<
Convert a signal to a Stream to be consumed as a read only stream.T> , provided by the ReadonlySignalUtils extension -
toString(
) → String -
A string representation of this object.
inherited
-
unsubscribeFromNode(
Node node) → void -
inherited
-
unwatch(
BuildContext context) → void -
Available on ReadonlySignal<
Stop subscriptions to updates on a signal for watchersT> , provided by the FlutterReadonlySignalUtils extension -
watch(
BuildContext context, {String? debugLabel}) → T -
Available on ReadonlySignal<
Rebuild the Element that the current signal is inside ofT> , provided by the FlutterReadonlySignalUtils extension
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited