added operator map types to language extensions #24
Conversation
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
lolleko
requested changes
Feb 6, 2021
docs/advanced/language-extensions.md
Outdated
| - LuaFloorDivision / LuaFloorDivisionMethod (`a // b`, only when targeting Lua 5.3 or later) | ||
| - LuaNegation / LuaNegationMethod (`-x`) | ||
| - Bitwise operators (only when targeting Lua 5.3 or later) | ||
| - BitwiseAnd / BitwiseAndMethod (`a & b`) |
Member
There was a problem hiding this comment.
Are Bitwise ops not prefixed with Lua?
Comment on lines
515
to
517
| However, there are workarounds that work decently. | ||
|
|
||
| One method is to declare a type as an intersection type with `number`. It will then inherit all mathematical operators. For example: |
Member
There was a problem hiding this comment.
Suggested change
| However, there are workarounds that work decently. | |
| One method is to declare a type as an intersection type with `number`. It will then inherit all mathematical operators. For example: | |
| However, there are two possible workarounds. The first one is to declare a type as an intersection type with `number`. It will then inherit all mathematical operators. Keep in mind that this is only partially type safe and may require some additional casting. | |
| Example: |
| const d = v3.dot(v2); | ||
| ``` | ||
|
|
||
| There are also language extensions that allow declaring special functions which will transpile to operators. For example: |
Member
There was a problem hiding this comment.
Suggested change
| There are also language extensions that allow declaring special functions which will transpile to operators. For example: | |
| The second option was added in version [0.38.0](https://github.com/TypeScriptToLua/TypeScriptToLua/blob/master/CHANGELOG.md#0380). You can now use [language extensions](https://typescripttolua.github.io/docs/advanced/language-extensions) that allow declaring special functions which will transpile to operators. This will be completely type safe if the operators are declared correctly. | |
| Example: |
Maybe mention this one first?
I think this should be the recommended variant.
Perryvw
reviewed
Feb 6, 2021
docs/advanced/language-extensions.md
Outdated
| export const mul: LuaMultiplication<Vector, Vector, number> & LuaMultiplication<Vector, number, Vector>; | ||
| } | ||
|
|
||
| const dot = Vector.mul(a, b); |
Member
There was a problem hiding this comment.
Might be nice to add types to these consts to demonstrate the point, ie const dot: number = and const scaled: Vector =
| const d = v3.dot(v2); | ||
| ``` | ||
|
|
||
| There are also language extensions that allow declaring special functions which will transpile to operators. For example: |
Member
There was a problem hiding this comment.
Seems like duplicate information, couldn't you just refer to the language extensions page? ./language-extensions.md#operator-map-types should do the trick
lolleko
approved these changes
Feb 6, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
No description provided.