suitest-js-api/lib/commands/stopRecording.js

Suitest is a test automation and device manipulation tool for living room devices and web browsers.

/**
 * Stop recording command.
 */

const wsContentTypes = require('../api/wsContentTypes');
const chainPromise = require('../utils/chainPromise');
const {stopRecordingMessage} = require('../texts');

/**
 * Stop recording
 * @param {suitest.ISuitest} instance of main class
 * @param {{discard: boolean}} [recordingSettings]
 * @returns {Promise<void>}
 */
async function stopRecording({webSockets, authContext, logger}, recordingSettings) {
	const discard = recordingSettings ? recordingSettings.discard : false;

	// authorize
	const authedContent = await authContext.authorizeWs(
		{
			type: wsContentTypes.stopRecording,
			discard,
		},
	);

	// make ws request
	await webSockets.send(authedContent);

	logger.log(stopRecordingMessage());
}

module.exports = chainPromise(stopRecording);