assertDivisibleBy method

void assertDivisibleBy(
  1. num divisor, {
  2. String? message,
})

Asserts that this number is evenly divisible by divisor.

Throws a test failure if this number is not evenly divisible by divisor.

Example:

10.assertDivisibleBy(2);  // Passes
10.assertDivisibleBy(5);  // Passes
10.assertDivisibleBy(3);  // Fails
  • divisor: The number to divide by.
  • message: Optional custom message for the failure reason.

Implementation

void assertDivisibleBy(num divisor, {String? message}) {
  expect(this % divisor == 0, isTrue,
      reason: message ?? 'Expected $this to be divisible by $divisor');
}