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.

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

makeSingleInstance lost its TypeScript definition in 3.0.0 tho it's only deprecated #14692

Closed
davidnorthetal opened this issue Sep 19, 2018 · 2 comments

Comments

@davidnorthetal
Copy link

  • Output of node_modules/.bin/electron --version: v3.0.0
  • Operating System (Platform and Version): Windows 10 x64
  • Output of node_modules/.bin/electron --version on last known working Electron version (if applicable): v2.0.5

Expected Behavior
I compile my TypeScript electron application.

No errors

Actual behavior
I compile my TypeScript electron application.

error TS2339: Property 'makeSingleInstance' does not exist on type 'App'.

Additional Information
makeSingleInstance got removed here: dcd580b

while this commit WAS NOT merged into 3.0.0 ( which is correct, according to https://github.com/electron/electron/blob/master/docs/api/breaking-changes.md#planned-breaking-api-changes-40 ), apparently the TypeScript definition got still removed

@MarshallOfSound
Copy link
Member

@davidnorthetal The TS definitions are generated from our docs and this deprecated API was removed from the docs and replaced with its new version requestSingleInstanceLock when we deprecated makeSingleInstance which did happen in 3.0. (we deprecate in 3.0 and remove in 4.0)

@davidnorthetal
Copy link
Author

@MarshallOfSound why did you close this? - I can see that this is the case, but isn't that clearly a bug?
If it's deprecated, it's deprecated, not gone. It's literally gone from TypeScripts perspective, not deprecated.

Is there a specification for how you guys deal with this? - Because to me this very much seems like an oversight.

For a TypeScript user, you're conflating deprecation and removal altogether and if this is actually the case I'd propose that it clearly states this in the breaking-change documentation: https://github.com/electron/electron/blob/master/docs/api/breaking-changes.md as it is very confusing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants