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

docs: process.getProcessMemoryInfo() returns a Promise #16593

Merged
merged 2 commits into from Mar 20, 2019

Conversation

@miniak
Copy link
Contributor

commented Jan 29, 2019

Description of Change

Fix process.getProcessMemoryInfo() return type, which is Promise<ProcessMemoryInfo>, not just ProcessMemoryInfo.

/cc @nitsakh

Checklist

Release Notes

Notes: Fixed process.getProcessMemoryInfo() return type to Promise<ProcessMemoryInfo in electron.d.ts.

@miniak miniak requested a review from nitsakh Jan 29, 2019

@miniak miniak requested a review from as a code owner Jan 29, 2019

@miniak miniak self-assigned this Jan 29, 2019

@miniak miniak added the target/5-0-x label Jan 29, 2019

@miniak miniak force-pushed the miniak/doc-fix-process-memory-info branch from aa098a1 to 54b95ad Jan 29, 2019

@miniak

This comment has been minimized.

Copy link
Contributor Author

commented Jan 29, 2019

The artifact comparison is broken after #16416

@miniak

This comment has been minimized.

Copy link
Contributor Author

commented Jan 29, 2019

There is an issue with the generator. It's producing getProcessMemoryInfo(): Electron.Promise; @MarshallOfSound can you please help?

@miniak

This comment has been minimized.

Copy link
Contributor Author

commented Jan 30, 2019

@zcbenz it's still not working properly, it's generating
getProcessMemoryInfo(): Promise<ProcessMemoryInfo>;
instead of
getProcessMemoryInfo(): Promise<Electron.ProcessMemoryInfo>;

@miniak miniak force-pushed the miniak/doc-fix-process-memory-info branch from 54b95ad to 66be611 Jan 30, 2019

@miniak miniak requested a review from as a code owner Jan 30, 2019

@alexeykuzmin

This comment has been minimized.

Copy link
Contributor

commented Jan 31, 2019

@miniak Since #16591 is merged, I added the "target/4-0-x" label to this PR to ensure it's backported.
cc @nitsakh

@alexeykuzmin

This comment has been minimized.

Copy link
Contributor

commented Jan 31, 2019

@miniak Can you please fix conflicts here?

@miniak miniak force-pushed the miniak/doc-fix-process-memory-info branch from 66be611 to e181cef Jan 31, 2019

@miniak

This comment has been minimized.

Copy link
Contributor Author

commented Jan 31, 2019

@alexeykuzmin rebased. It's still not generated properly:

-    getProcessMemoryInfo(): Electron.ProcessMemoryInfo;
+    getProcessMemoryInfo(): Promise<ProcessMemoryInfo>;
@codebytere

This comment has been minimized.

Copy link
Member

commented Feb 4, 2019

@miniak

index.d.ts(10015,37): error TS2304: Cannot find name 'ProcessMemoryInfo'

is likely why it's not generating properly. Check relative paths maybe?

@MarshallOfSound

This comment has been minimized.

Copy link
Member

commented Feb 5, 2019

@codebytere This is a bug in the typescript generator not prefixing the innerType correctly in this case, can hack it in tonight

@miniak

This comment has been minimized.

Copy link
Contributor Author

commented Feb 14, 2019

@MarshallOfSound did you have time to check the code generator?

@miniak

This comment has been minimized.

Copy link
Contributor Author

commented Mar 2, 2019

@MarshallOfSound ping on the typescript generator

@miniak miniak force-pushed the miniak/doc-fix-process-memory-info branch from e181cef to 2feb919 Mar 2, 2019

@MarshallOfSound

This comment has been minimized.

Copy link
Member

commented Mar 8, 2019

@MarshallOfSound

This comment has been minimized.

Copy link
Member

commented Mar 14, 2019

@miniak Bumping electron-typescript-definitions in this PR should get everything working again 👍

@MarshallOfSound MarshallOfSound force-pushed the miniak/doc-fix-process-memory-info branch from 2feb919 to ab0bc5d Mar 19, 2019

@MarshallOfSound
Copy link
Member

left a comment

I updated electron-typescript-definitions and it all looks good now 👍

@alexeykuzmin alexeykuzmin merged commit de1bacd into master Mar 20, 2019

12 of 15 checks passed

Artifact Comparison Changes Detected
Details
Backportable? - 4-0-x Cancelled
Details
Backportable? - 5-0-x Cancelled
Details
Semantic Pull Request ready to be squashed
Details
WIP Ready for review
Details
appveyor: win-ia32-testing AppVeyor build succeeded
Details
appveyor: win-ia32-testing-pr AppVeyor build succeeded
Details
appveyor: win-x64-testing AppVeyor build succeeded
Details
appveyor: win-x64-testing-pr AppVeyor build succeeded
Details
build-linux Workflow: build-linux
Details
build-mac Workflow: build-mac
Details
electron-arm-testing Build #20190319.31 succeeded
Details
electron-arm64-testing Build #20190319.31 succeeded
Details
lint Workflow: lint
Details
release-notes Release notes found
@release-clerk

This comment has been minimized.

Copy link

commented Mar 20, 2019

Release Notes Persisted

Fixed process.getProcessMemoryInfo() return type to Promise<ProcessMemoryInfo in electron.d.ts.

@alexeykuzmin alexeykuzmin deleted the miniak/doc-fix-process-memory-info branch Mar 20, 2019

@miniak miniak referenced this pull request Mar 20, 2019

Merged

build: strip trailing whitespace in docs #17488

3 of 3 tasks complete

Kiku-Reise added a commit to Kiku-Reise/electron that referenced this pull request May 16, 2019

docs: process.getProcessMemoryInfo() returns a Promise (electron#16593)
* docs: process.getProcessMemoryInfo() returns a Promise
* chore: bump electron-typescript-definitions to get Promise<T> fix
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.