SignalOptions API docs

Signal options which increase the behaviour of the signal.

Constructor#

const SignalOptions({
  String? name,
  bool equals = false,
  ValueComparator<T?>? comparator = identical,
  bool autoDispose = true,
});

The name of the signal, useful for logging purposes.

Whether to check the equality of the value with the == equality.

Preventing signal updates if the new value is equal to the previous.

When this value is true, the comparator is not used.

An optional comparator function, defaults to identical.

Preventing signal updates if the comparator returns true.

Taken into account only if equals is false.

Whether to automatically dispose the signal (defaults to true).

This happens automatically when there are no longer subscribers. If you set it to false, you should remember to dispose the signal manually