Deprecate mediaRecorderOptions #251 #268
Open
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
added a line @deprecated Use individual options instead of mediaRecorderOptions.
clabe45
requested changes
Apr 28, 2024
| @@ -273,6 +273,8 @@ export class Movie { | |||
| * @param [options.type='video/webm'] - MIME type for exported video | |||
| * @param [options.onStart] - Called when the recording starts | |||
| * @return Resolves when done recording, rejects when media recorder errors | |||
| * @deprecated Use individual options instead of mediaRecorderOptions. | |||
| * | |||
There was a problem hiding this comment.
Please remove this blank line
| @@ -273,6 +273,8 @@ export class Movie { | |||
| * @param [options.type='video/webm'] - MIME type for exported video | |||
| * @param [options.onStart] - Called when the recording starts | |||
| * @return Resolves when done recording, rejects when media recorder errors | |||
| * @deprecated Use individual options instead of mediaRecorderOptions. | |||
There was a problem hiding this comment.
Can you add an example of which individual options we're referring to (for users)? Something like
Use individual options (such as `type`) instead.| @@ -273,6 +273,8 @@ export class Movie { | |||
| * @param [options.type='video/webm'] - MIME type for exported video | |||
| * @param [options.onStart] - Called when the recording starts | |||
| * @return Resolves when done recording, rejects when media recorder errors | |||
| * @deprecated Use individual options instead of mediaRecorderOptions. | |||
There was a problem hiding this comment.
It looks like @deprecated only applies to the entire function (https://stackoverflow.com/a/42457901/3783155). To only deprecate mediaRecorderOptions, you may need to add a docstring with @deprecated to mediaRecorderOptions in the options type definition below.
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.
added a line
@deprecated Use individual options instead of mediaRecorderOptions.