docs: fix electron.d.ts typings #13841
Merged
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
miniak
force-pushed
the
miniak/fix-typings
branch
from
1e9a037
to
ae1f6ad
Compare
miniak
changed the title
miniak
force-pushed
the
miniak/fix-typings
branch
from
ae1f6ad
to
5104f9f
Compare
|
@zeke can you please review? |
Closed
| @@ -194,7 +194,7 @@ Sets the `image` associated with this tray icon. | |||
|
|
|||
| #### `tray.setPressedImage(image)` _macOS_ | |||
|
|
|||
| * `image` [NativeImage](native-image.md) | |||
| * `image` ([NativeImage](native-image.md) | String) | |||
There was a problem hiding this comment.
Instead of documenting everywhere that NativeImage can also be a string I think it makes more sense to remove this duplication and update electron-typescript-definitions to alias NativeImage to NativeImage | String
There was a problem hiding this comment.
Note this won't block this PR, just a thing we should probably do in the future
MarshallOfSound
approved these changes
Jul 30, 2018
|
We have automatically backported this PR to "1-8-x", please check out #13855 |
|
We have automatically backported this PR to "2-0-x", please check out #13856 |
|
We have automatically backported this PR to "3-0-x", please check out #13857 |
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.
Fixes #13577
win.setOverlayIcon(overlay, description)- overlay can benulltray.setPressedImage(image)- image can bestringChecklist
(https://github.com/electron/electron/blob/master/docs/development/testing.md)