-
-
Notifications
You must be signed in to change notification settings - Fork 251
Document tagged templates #803
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
Merged
fhammerschmidt
merged 13 commits into
rescript-lang:master
from
tsnobip:tagged_templates
Feb 1, 2024
Merged
Changes from 2 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
2fd1043
mark latest version as v11 instead of v11.0
tsnobip afa3e0c
document tagged templates from rescript-lang/rescript-compiler#6250
tsnobip c796a71
better document JS tagged templates
tsnobip ef7828b
improve Bun shell example
tsnobip 380a860
link to other JS tagged template functions
tsnobip 37fcc8f
document how to define tag functions in rescript
tsnobip 4949dfe
reword bindings to JS tag functions
tsnobip c0cc9dd
upgrade highlightjs to v11 and use tsnobip/higlightjs-rescript
tsnobip 8dea5b0
add rescript v11.1-rc.1 to compiler dependencies
tsnobip 068915d
capitalize correctly ReScript
tsnobip 7bf0c59
run the examples with rescript 11.1
tsnobip 34ca067
add @rescript/react as a dependency for examples
tsnobip 137e18d
configure react and jsx when building examples
tsnobip File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
id: "taggedTemplate-decorator" | ||
keywords: ["taggedTemplate", "tagged", "template", "decorator"] | ||
name: "@taggedTemplate" | ||
summary: "This is the `@taggedTemplate` decorator." | ||
category: "decorators" | ||
--- | ||
**Since 11.1** | ||
|
||
The `@taggedTemplate` decorator is used to bind to JavaScript tag functions. | ||
|
||
### Example | ||
|
||
<CodeTab labels={["ReScript", "JS Output"]}> | ||
|
||
```res example | ||
type res | ||
@module("bun") @taggedTemplate | ||
external sh: (array<string>, array<string>) => promise<res> = "$" | ||
tsnobip marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
let filename = "index.res" | ||
let res = await sh`ls ${filename}` | ||
``` | ||
|
||
```js | ||
import * as $$Bun from "bun"; | ||
var filename = "index.res" | ||
var res = await $$Bun.$`ls ${filename}` | ||
``` | ||
|
||
</CodeTab> | ||
|
||
### References | ||
|
||
* [Tagged template functions](/docs/manual/latest/bind-to-js-function#tagged_template-functions) |
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
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
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.