Add scaleFactor to CLI | Add .cancel function #20
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sindresorhus
requested changes
May 14, 2021
index.d.ts
Outdated
| /** | ||
| Scale factor to use | ||
| Useful when recording retina screens, or for resizing the recorded video | ||
| */ |
There was a problem hiding this comment.
Is it worth adding prettier to the project? Would avoid these sort of issues.
There was a problem hiding this comment.
Nah. prettier does indeed make things more consistent, but IMHO also less readable and ugly.
index.d.ts
Outdated
| /** | ||
| Cancels a recording, if it was started | ||
| */ | ||
| cancelRecording: () => void; |
There was a problem hiding this comment.
I just noticed that we have been very inconsistent with naming. I think this should be cancel(). I'll fix the other methods when this is merged.
|
You need to update the readme too. |
|
For next time, the |
dac09
changed the title
sindresorhus
reviewed
Oct 4, 2021
Comment on lines
+42
to
+43
|
|
||
| recorderTimeout = undefined |
There was a problem hiding this comment.
Suggested change
| recorderTimeout = undefined | |
| _recorderTimeout = undefined |
sindresorhus
reviewed
Oct 4, 2021
| @@ -101,6 +108,11 @@ declare namespace aperture { | |||
| Returns a `Promise` for the path to the screen recording file. | |||
| */ | |||
| stopRecording: () => Promise<string>; | |||
|
|
|||
| /** | |||
| Cancels a recording, if it was started | |||
There was a problem hiding this comment.
Suggested change
| Cancels a recording, if it was started | |
| Cancels a recording if it was running. |
|
Readme and index.d.ts should be fully in sync. |
sindresorhus
reviewed
Oct 4, 2021
Comment on lines
+66
to
+68
| Scale factor to use | ||
| The actual height and width of the capture will be multiplied by this number to create the height and width of the output. | ||
| @default 1 |
There was a problem hiding this comment.
Suggested change
| Scale factor to use | |
| The actual height and width of the capture will be multiplied by this number to create the height and width of the output. | |
| @default 1 | |
| The scale factor to use. | |
| The actual height and width of the capture will be multiplied by this number to create the height and width of the output. | |
| @default 1 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does it do?
cancelfunction to stop and discard the recordingFixes #18
Please note I haven't had a chance to test this out yet on this version, but I am using something similar in my older fork