Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@guidepup/record

guidepup3.2kMIT0.1.0TypeScript support: included

Tools for screen recording.

recording, record, screencapture, screen-recording

readme

Record

Available on NPM Test workflows This project uses the MIT license

Getting Started

Install to your project:

npm install @guidepup/record

Windows

Start a screen recording on Windows:

import { windowsRecord } from "@guidepup/record";

(async () => {
  // Start the screen recording passing the location to save the recording.
  const stopRecording = windowsRecord("./recordings/screenRecording.mp4");

  // ... perform some commands.

  // Stop the screen recording.
  stopRecording();
})();

MacOS

Start a screen recording on MacOS.

import { macOSRecord } from "@guidepup/record";

(async () => {
  // Start the screen recording passing the location to save the recording.
  const stopRecording = macOSRecord("./recordings/screenRecording.mov");

  // ... perform some commands.

  // Stop the screen recording.
  stopRecording();
})();

Resources