Add destinationPath option to .startRecording()

example.js

@@ -1,5 +1,5 @@
 'use strict';
-const fs = require('fs');
+const path = require('path');
 const delay = require('delay');
 const aperture = require('.');
 
@@ -8,12 +8,13 @@ async function main() {
  console.log('Screens:', await aperture.screens());
  console.log('Audio devices:', await aperture.audioDevices());
  console.log('Preparing to record for 5 seconds');
- await recorder.startRecording();
+ await recorder.startRecording({
+ destinationPath: path.join(__dirname, 'test.mp4')
+ });
  console.log('Recording started');
  await delay(5000);
  const fp = await recorder.stopRecording();
- fs.renameSync(fp, 'recording.mp4');
- console.log('Video saved in the current directory');
+ console.log('Video saved in the current directory', fp);
 }
 
 main().catch(console.error);

index.js

@@ -32,6 +32,7 @@ class Aperture {
  }
 
  startRecording({
+ destination = undefined,
  fps = 30,
  cropArea = undefined,
  showCursor = true,
@@ -46,7 +47,12 @@ class Aperture {
  return;
  }
 
- this.tmpPath = tempy.file({extension: 'mp4'});
+ this.tmpPath = destination ? destination : tempy.file({extension: 'mp4'});
+
+ if (destination && (typeof destination !== 'string' || !destination.includes('mp4'))) {
+ reject(new Error('Invalid `destination` option string'));
+ return;
+ }
 
  if (highlightClicks === true) {
  showCursor = true;

readme.md

@@ -1,3 +1,4 @@
+
 # aperture-node [![Build Status](https://travis-ci.org/wulkano/aperture-node.svg?branch=master)](https://travis-ci.org/wulkano/aperture-node)
 
 > Record the screen on macOS from Node.js
@@ -32,7 +33,7 @@ const options = {
  await aperture.startRecording(options);
  await delay(3000);
  console.log(await aperture.stopRecording());
- //=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/cdf4f7df426c97880f8c10a1600879f7.mp4'
+ //=> '/private/var/folders/3x/jf5977fn79j/T/cdf4f7df426c97880f8c10a1600879f7.mp4'
 })();
 ```
 
@@ -88,14 +89,25 @@ Map {
 
 Returns a `Promise` for the path to the screen recording file.
 
-Fullfills when the recording starts or rejects if the recording didn't start after 5 seconds.
+Fulfills when the recording starts or rejects if the recording didn't start after 5 seconds.
 
 #### recorder.stopRecording()
 
 Returns a `Promise` for the path to the screen recording file.
 
 ## Options
 
+#### destinationPath
+
+Type: `string`<br>
+Default: `undefined`
+
+Destination of the output file. When `undefined`, destination will be generated using [tempy](https://github.com/sindresorhus/tempy) (default).
+
+`destinationPath` can be useful when needing to store temporary data on a different external network or local drive, allowing for higher capacity file storage ([further discussion](https://github.com/wulkano/aperture-node/pull/7#issuecomment-533199701)). 
+
+This option should only be used when necessary. If `destinationPath` is not defined, then [tempy](https://github.com/sindresorhus/tempy) is used to generate an available filename and path in the user's temporary directory, eg. `/private/var/folders/3x/jf5977fn79j/T/vid.mp4`.
+
 #### fps
 
 Type: `number`<br>