Add TypeScript definition

[CvX]

[WIP] There are still a couple of TODOs to be resolved.

edit:
🚀

[sindresorhus]

Can you mark properties that are meant as read-only with readonly and if all are readonly, you could use the Readonly helper.

https://basarat.gitbooks.io/typescript/docs/types/readonly.html

[sindresorhus]

Suggested change

	url: string;
	url?: string;

[CvX]

Here the url option is required: https://github.com/sindresorhus/electron-util/blob/e2ea4fd/index.js#L221-L223

[CvX]

@sindresorhus Correct me if I'm wrong, but it seems that there's a type incompatibility here.

Both openUrlMenuItem() and aboutMenuItem() create and return instances of Electron.MenuItem. In their examples/README (and in Caprine) these are used in Electron.Menu.buildFromTemplate([]) as either top-level items or in submenu.

Those accept MenuItemConstructorOptions:

submenu?: (MenuItemConstructorOptions[]) | (Menu);

static buildFromTemplate(template: MenuItemConstructorOptions[]): Menu;

These are not compatible with MenuItem. I believe it currently works just because the MenuItem constructor assigns all properties from options, so when options are another MenuItem instance, it essentially copies it?

[sindresorhus]

Wow. Good catch. Let's change them to return MenuItemConstructorOptions.

[sindresorhus]

I'm gonna open an issue tomorrow about Electron supporting MenuItem too in the template builder, but that will probably take a long time, if ever.

[CvX]

Wow. Good catch. Let's change them to return MenuItemConstructorOptions.

That's TypeScript at work! 😄I've been testing these type definitions inside Caprine's codebase, so it got flagged instantly. 🙂

[sindresorhus]

Woah. This was a massive undertaking and you did an amazing job at it! 🎉

[sindresorhus]

Published: https://github.com/sindresorhus/electron-util/releases/tag/v0.11.0

[sindresorhus]

I'm gonna open an issue tomorrow about Electron supporting MenuItem too

Done: electron/electron#16645

[sindresorhus]

@CvX Would you be willing to submit this to https://github.com/sindresorhus/type-fest ? I'm trying to consolidate the types I use so they can be properly documented and tested in one place.