GoldenToolkitConfiguration class

Represents configuration options for the GoldenToolkit. These are akin to environmental flags.

Annotations

• @immutable

Constructors

GoldenToolkitConfiguration({SkipGoldenAssertion skipGoldenAssertion = _doNotSkip, FileNameFactory fileNameFactory = defaultFileNameFactory, DeviceFileNameFactory deviceFileNameFactory = defaultDeviceFileNameFactory, PrimeAssets primeAssets = defaultPrimeAssets, List<Device> defaultDevices = const [Device.phone, Device.tabletLandscape], bool enableRealShadows = false, Object? tags = const ['golden']})

GoldenToolkitConfiguration constructor

Properties

defaultDevices → List<Device>

the default set of devices to use for multiScreenGolden assertions

final

deviceFileNameFactory → DeviceFileNameFactory

A function to determine the file name/path multiScreenGolden uses to call matchesGoldenFile.

final

enableRealShadows → bool

whether shadows should have the real rendering by default, Widget tests use opaque shadows to avoid golden test failures See debugDisableShadows for more context

final

fileNameFactory → FileNameFactory

A function to determine the file name/path screenMatchesGolden uses to call matchesGoldenFile.

final

hashCode → int

The hash code for this object.

no setter, override

primeAssets → PrimeAssets

A function that primes all needed assets for the given tester. Defaults to defaultPrimeAssets.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

skipGoldenAssertion → SkipGoldenAssertion

a function indicating whether a golden assertion should be skipped

final

tags → Object?

the tags golden test are tagged with, defaults to 'golden', must be null, String or Iterable

final

Methods

copyWith({SkipGoldenAssertion? skipGoldenAssertion, FileNameFactory? fileNameFactory, DeviceFileNameFactory? deviceFileNameFactory, PrimeAssets? primeAssets, List<Device>? defaultDevices, bool? enableRealShadows, Object? tags}) → GoldenToolkitConfiguration

Copies the configuration with the given values overridden.

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.

override