assertMultipleOf method

void assertMultipleOf(
  1. num factor, {
  2. String? message,
})

Asserts that this number is a multiple of factor.

Throws a test failure if this number is not a multiple of factor.

Example:

10.assertMultipleOf(5);  // Passes
10.assertMultipleOf(2);  // Passes
10.assertMultipleOf(3);  // Fails
  • factor: The factor to check against.
  • message: Optional custom message for the failure reason.

Implementation

void assertMultipleOf(num factor, {String? message}) {
  expect(this / factor % 1 == 0, isTrue,
      reason: message ?? 'Expected $this to be a multiple of $factor');
}