Options class

Options class is a class used to set options for the approval test.

Constructors

Options({ApprovalScrubber scrubber = const ScrubNothing(), bool approveResult = false, Comparator comparator = const FileComparator(), Reporter reporter = const CommandLineReporter(), bool deleteReceivedFile = true, Namer? namer, bool logErrors = true, bool logResults = true, bool includeClassNameDuringSerialization = true})
const

Properties

approveResult → bool
A final bool variable approveResult used to determine if the result should be approved after the test.
final
comparator → Comparator
A final variable comparator of type Comparator used to compare the approved and received files.
final
deleteReceivedFile → bool
A final bool variable deleteReceivedFile used to determine if the received file should be deleted after passed test.
final
hashCode → int
The hash code for this object.
no setterinherited
includeClassNameDuringSerialization → bool
A final bool variable includeClassNameDuringSerialization used to determine if the class name should be included during serialization.
final
logErrors → bool
A final bool variable logErrors used to determine if the errors should be logged.
final
logResults → bool
A final bool variable logResults used to determine if the results should be logged.
final
namer → Namer?
A final variable namer of type Namer used to set the name and path of the file.
final
reporter → Reporter
A final variable reporter of type Reporter used to report the comparison results.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scrubber → ApprovalScrubber
scrubber is a scrubber that is used to clean up strings before they are compared.
final

Methods

copyWith({ApprovalScrubber? scrubber, bool? approveResult, Comparator? comparator, Reporter? reporter, bool? deleteReceivedFile, Namer? namer, bool? logErrors, bool? logResults, bool? includeClassNameDuringSerialization}) → Options
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited