Skip to content

Add syntax lookup triangle pipe operator #193

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
merged 1 commit into from
Jan 15, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions misc_docs/syntax/operators_triangle_pipe.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
id: "triangle-pipe"
keywords: [pipe", "triangle", "operator", "function", "argument"]
name: "|>"
summary: "This is the `triangle pipe` operator."
category: "operators"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

at some point we should probably introduce some deprecated: true field, to "grey out" labels in the overview maybe?

---

The `|>` operator passes a value to a function as its last argument.

> Note that this operator has been deprecated. See [Triangle Pipe](/docs/manual/latest/pipe#triangle-pipe-deprecated) for more details.

### Example

<CodeTab labels={["ReScript", "JS Output"]}>

```res
let dieRoll = size => {
Js.Math.random_int(1, size)
}

let dieRollMessage = (name, value) => {
"Hi " ++ name ++ ", you rolled a " ++ Js.Int.toString(value)
}

let message = dieRoll(6) |> dieRollMessage("Jeremy")
```

```js
function dieRoll(size) {
return Js_math.random_int(1, size);
}

function dieRollMessage(name, value) {
return "Hi " + name + ", you rolled a " + value.toString();
}

var message = dieRollMessage("Jeremy", Js_math.random_int(1, 6));
```

</CodeTab>

Which produces a message such as `Hello Jeremy, you rolled a 3`.

### References

* [Triangle Pipe](/docs/manual/latest/pipe#triangle-pipe-deprecated)