@serenity-js/assertions/lib/expectations/isFalse.js

Serenity/JS universal assertion library supporting all types of functional tests, including both web and REST API scenarios

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.isFalse = isFalse;
const core_1 = require("@serenity-js/core");
const equals_1 = require("./equals");
/**
 * Creates an [expectation](https://serenity-js.org/api/core/class/Expectation/) that is met when the actual `boolean` value
 * is `false`.
 *
 * ## Ensuring that a given value is false
 *
 * ```ts
 * import { actorCalled } from '@serenity-js/core'
 * import { Ensure, isFalse } from '@serenity-js/assertions'
 * import { Cookie } from '@serenity-js/web'
 *
 * await actorCalled('Ester').attemptsTo(
 *   Ensure.that(Cookie.called('example-regular-cookie').isSecure(), isFalse()),
 * )
 * ```
 *
 * @group Expectations
 */
function isFalse() {
    return core_1.Expectation.to(`equal false`).soThatActual((0, equals_1.equals)(false));
}
//# sourceMappingURL=isFalse.js.map