Added language extensions page #20
Merged
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
hazzard993
suggested changes
Dec 26, 2020
docs/advanced/language-extensions.md
Outdated
| ``` | ||
|
|
||
| :::note | ||
| Prefer MultiReturn over the similar [@tupleReturn anotation](./compiler-annotations.md#tuplereturn). MultiReturn can do anything tupleReturn can, with the added benefit of being able to distinguish between actual tuple tables and multiple return values in the type system. |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
|
|
||
| ```ts title=stringfind.ts | ||
| declare namespace string { | ||
| export function find(haystack: string, needle: string): MultiReturn<[number, number]>; |
There was a problem hiding this comment.
Not sure if someone will question why this doesn't work the same in the future.
this: void or @noSelf would be required. Unless the namespace is defined elsewhere with that very annotation like it is in the playground
There was a problem hiding this comment.
Ah no it works because string has @noSelfInFile
docs/advanced/language-extensions.md
Outdated
|
|
||
| import { SideBySide } from "@site/src/components/SideBySide"; | ||
|
|
||
| TypeScriptToLua provides several extensions to typescript in the form of types and helper functions. To use these language extensions, add the types to your `tsconfig.json`: |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
docs/advanced/language-extensions.md
Outdated
|
|
||
| ## MultiReturn Type | ||
|
|
||
| This language extension allows typing of Lua functions that return multiple values. For example, consider Lua's `string.find`, it returns two indices: the start of the found substring and the end of the found substring. In TypeScript, function can only return one value so a special type is needed to indicate to tstl there are multiple return values. This is the `MultiReturn<>` type. |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
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.
No description provided.