-
Notifications
You must be signed in to change notification settings - Fork 1
/
docs.json
28 lines (28 loc) · 1.01 KB
/
docs.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
[
{
"name": "PortMessage",
"comment": " Useful functions for building a PortMessage to be delivered through ports.\n\n@docs PortMessage\n\n\n# Builder\n\n@docs new, withPayload\n\n",
"aliases": [
{
"name": "PortMessage",
"comment": " ",
"args": [],
"type": "{ tag : String, payload : Json.Encode.Value }"
}
],
"types": [],
"values": [
{
"name": "new",
"comment": " Create a new PortMessage with an empty payload.\n\n new \"SomeAction\" == { tag = \"SomeAction\", payload = null }\n\n",
"type": "String -> PortMessage.PortMessage"
},
{
"name": "withPayload",
"comment": " Attach a payload to the PortMessage\n\n new \"JoinChannel\"\n |> withPayload (Json.Encode.string \"lobby\")\n == { tag = \"JoinChannel\", payload = \"lobby\" }\n\n",
"type": "Json.Encode.Value -> PortMessage.PortMessage -> PortMessage.PortMessage"
}
],
"generated-with-elm-version": "0.18.0"
}
]