PeekOptions class final
How a Peek instance behaves.
- Annotations
Constructors
- PeekOptions({PeekLimits limits = const PeekLimits(), PeekRedactionPolicy redaction = PeekRedactionPolicy.none, PeekClock clock = const PeekSystemClock(), PeekErrorHandler? onError, bool enabled = true, String? name})
-
Creates options; every default suits a debug build of a typical app.
const
Properties
- clock → PeekClock
-
The clock Peek and its UI read the current time from.
final
- enabled → bool
-
Whether Peek records anything at all. Pass
kDebugModeto switch it off in release builds without touching the adapters.final - hashCode → int
-
The hash code for this object.
no setterinherited
- limits → PeekLimits
-
How much is kept.
final
- name → String?
-
What the app calls itself in a saved session and on a desktop viewer.
final
- onError → PeekErrorHandler?
-
Where swallowed errors go;
nulldrops them.final - redaction → PeekRedactionPolicy
-
What is masked before it is kept; nothing, by default.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
copyWith(
{PeekLimits? limits, PeekRedactionPolicy? redaction, PeekClock? clock, PeekErrorHandler? onError, bool? enabled, String? name}) → PeekOptions - A copy with the given fields replaced.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited