From 0157ab971ee7c3f3d2a67ed6f750a2da79853069 Mon Sep 17 00:00:00 2001 From: Kevan Stannard Date: Fri, 15 Jan 2021 22:13:17 +1100 Subject: [PATCH] Add syntax lookup triangle pipe operator --- misc_docs/syntax/operators_triangle_pipe.mdx | 47 ++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 misc_docs/syntax/operators_triangle_pipe.mdx diff --git a/misc_docs/syntax/operators_triangle_pipe.mdx b/misc_docs/syntax/operators_triangle_pipe.mdx new file mode 100644 index 000000000..b3db593ae --- /dev/null +++ b/misc_docs/syntax/operators_triangle_pipe.mdx @@ -0,0 +1,47 @@ +--- +id: "triangle-pipe" +keywords: [pipe", "triangle", "operator", "function", "argument"] +name: "|>" +summary: "This is the `triangle pipe` operator." +category: "operators" +--- + +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 + + + +```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)); +``` + + + +Which produces a message such as `Hello Jeremy, you rolled a 3`. + +### References + +* [Triangle Pipe](/docs/manual/latest/pipe#triangle-pipe-deprecated)