Include fields with their types in the return type annotation when it's a table with known fields#1
Open
anaissls wants to merge 1 commit into
Open
Include fields with their types in the return type annotation when it's a table with known fields#1anaissls wants to merge 1 commit into
anaissls wants to merge 1 commit into
Conversation
…known fields and types
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
There are a few functions that return a table with known fields, such as
love.filesystem.getInfo(), which in the love api, its return type is a table with the following fields and types:{type:FileType, size:number, modtime:number}.However, in these cases, the return type is generated as
table, with no hints about the fields it has.This small modification changes the return type in these cases, replacing it with an annotation that includes the fields and its types as defined in the love api:
There are seven of such cases (not including function overloads).
Found the change easy to implement, so I wanted to contribute to this EmmyLua love annotations fork, which seems to be the most up to date.