@serenity-js/core/lib/screenplay/questions/Masked.js

The core Serenity/JS framework, providing the Screenplay Pattern interfaces, as well as the test reporting and integration infrastructure

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Masked = void 0;
const Question_1 = require("../Question");
/**
 * This question masks sensitive data handled by the actors and prevents
 * it from being shown in Serenity/JS reports and console logs.
 * You should use it to wrap passwords, secret tokens, phone numbers,
 * credit card numbers, or any other personally identifiable information (PII).
 * However, even though the wrapped value is masked in the output,
 * you can still retrieve the unmasked value by making the actor answer
 * the question in your custom interactions.
 *
 * @group Questions
 */
class Masked {
    /**
     * Retrieves the value of a sensitive parameter and mask it in any report.
     *
     * #### Example
     *
     * ```ts
     * import { actorCalled, Masked } from '@serenity-js/core';
     * import { Ensure, equals } from '@serenity-js/assertions';
     *
     * await actorCalled('John')
     *   .attemptsTo(
     *     Enter.theValue(Masked.valueOf('your little secret')).into(Form.exampleInput())
     *   );
     * ```
     *
     * @param parameter
     *  An [`Answerable`](https://serenity-js.org/api/core/#Answerable) representing the masked value.
     * @returns
     *  A [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter) representing the masked value.
     */
    static valueOf(parameter) {
        return Question_1.Question.about('[a masked value]', async (actor) => actor.answer(parameter));
    }
}
exports.Masked = Masked;
//# sourceMappingURL=Masked.js.map