Add first draft of typescript definitions #3202
Merged
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.
I've created a first draft of the typescript definitions file. I've attached a quick gif showing how it helps on developer workflow, even if the developer is not using Typescript (baked in in Visual Studio Code, but can easily be setup for other editors).
I've relied on the http://pm2.keymetrics.io/docs/usage/pm2-api/ documentation to create the definitions, since there's a lot of comments there I could reuse. However, this might not reflect accurately what's in code, so I'll be making a second pass at the code, making sure it accurately translates what's on the documentation. I might also add other functions that are not documented.
Let me know if this is a good direction to take this into, I hope this is helpful.