-
Notifications
You must be signed in to change notification settings - Fork 84
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Deprecate mediaRecorderOptions #251 #268
base: master
Are you sure you want to change the base?
Conversation
added a line @deprecated Use individual options instead of mediaRecorderOptions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks so much for contributing 🙏 and sorry for the long delay, I didn't see this until now
@@ -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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
added a line
@deprecated Use individual options instead of mediaRecorderOptions.