Skip to content
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.

Sign up for GitHub

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

Add TypeScript definition #11

Merged
merged 18 commits into from
Jan 29, 2019
Merged

Add TypeScript definition #11

Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
b00e299
Add TypeScript definition
CvX Jan 28, 2019
9b82683
Use descriptive names for generic parameters
CvX Jan 28, 2019
a50c3df
Mark readonly properties
CvX Jan 28, 2019
babba86
Remove options `@param`s where not needed
CvX Jan 28, 2019
17b9c8f
Mark optional params in JSDoc
CvX Jan 28, 2019
950fb96
Fix typo
CvX Jan 28, 2019
721679c
Noop -> no-op
CvX Jan 28, 2019
092cd18
Fix darkMode.onChange return type
CvX Jan 28, 2019
480bed4
Import classes/types from Electron
CvX Jan 28, 2019
ddb8412
Use readonly props
CvX Jan 28, 2019
51f2d27
Update new-github-issue-url
CvX Jan 28, 2019
0c53e6b
Revert "Mark optional params in JSDoc"
CvX Jan 28, 2019
30a785d
Use NewGithubIssueUrlOptions type
CvX Jan 28, 2019
ee69566
Fix TODOs
CvX Jan 29, 2019
189de4f
Fix `openUrlMenuItem` and `aboutMenuItem` return types
CvX Jan 29, 2019
599801f
Fix type tests
CvX Jan 29, 2019
0959665
Import Electron types in type definition tests
CvX Jan 29, 2019
3b29ddb
Extract the Omit type
CvX Jan 29, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Revert "Mark optional params in JSDoc" 
This reverts commit 17b9c8f.

# Conflicts:
#	index.d.ts
  • Loading branch information
@CvX
CvX committed Jan 28, 2019
commit 0c53e6b9929eb4e2bcb1cb3e006e5aa99a5a680b
6 changes: 3 additions & 3 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ export function activeWindow(): BrowserWindow;
* Run some JavaScript in the active or given window.
*
* @param code - TODO
* @param [window] - Default: Current window
* @param window - Default: Current window
* @returns A promise for the result of the executed code or a rejected promise if the result is a rejected promise.
*/
export function runJS(code: string, window?: BrowserWindow): Promise<unknown>;
Expand Down Expand Up @@ -269,7 +269,7 @@ export function centerWindow(options?: CenterWindowOptions): void;
/**
* Disable zooming, usually caused by pinching the trackpad on macOS or Ctrl+ on Windows.
*
* @param [window] - Default: Current window
* @param window - Default: Current window
*/
export function disableZoom(window?: BrowserWindow): void;

Expand Down Expand Up @@ -497,7 +497,7 @@ export function debugInfo(): string;
* Creating the [app menu](https://developer.apple.com/design/human-interface-guidelines/macos/menus/menu-bar-menus/) (the first menu) on macOS requires [a lot of boilerplate](https://github.com/sindresorhus/caprine/blob/5361289d1058b9463946f274cbfef587e6ad24a3/menu.js#L381-L431).
* This method includes the default boilerplate and lets you add additional menu items in the correct place.
*
* @param [menuItems] - Menu items to add below the `About App Name` menu item. Usually, you would add at least a `Preferences…` menu item.
* @param menuItems - Menu items to add below the `About App Name` menu item. Usually, you would add at least a `Preferences…` menu item.
* @returns TODO
*
* @example
Expand Down