chazsconi/elm-phoenix-ports/1.0.0

NOTE: the latest version is 2.1.0

Rerouted (retagged, needs approval). The tag now points at a different commit than when this version was published. The Lamdera package server serves a copy recovered from https://github.com/chazsconi/elm-phoenix-ports.

What we checked: Tag 1.0.0 is still on github.com/chazsconi/elm-phoenix-ports; its commit d2dc645ca390 is from 2020-06-07 10:15 UTC, after the version was published (2020-06-07 09:33 UTC); elm.json differs from package.elm-lang.org's; the exposed modules match docs.json; the zip's SHA-1 is not the published one and nothing else confirms its contents.

We could not verify this copy against what was published, so the Lamdera compiler asks before using it (y/n). Without a terminal, as in CI, it stops with an error unless approved:

  • lamdera make --auto-approve-package-rerouting approves rerouted versions for that run,
  • LAMDERA_AUTO_APPROVE_PACKAGE_REROUTING=1 does the same for every run in that environment,
  • LAMDERA_CACHE=off skips the Lamdera package server altogether: packages come from package.elm-lang.org and GitHub only, as with elm, and a rerouted version then fails to download.

Details · package.elm-lang.org's zip: https://github.com/chazsconi/elm-phoenix-ports/zipball/1.0.0/

Phoenix.Socket

A socket declares to which endpoint a socket connection should be established.

Definition

type alias Socket msg =
PhoenixSocket msg

Representation of a Socket connection

Helpers

init : String -> Socket msg

Initialize a Socket connection with an endpoint.

init "ws://localhost:4000/socket/websocket"
withParams : List ( String, String ) -> Socket msg -> Socket msg

Attach parameters to the socket connecton. You can use this to do authentication on the socket level. This will be the first argument (as a map) in your connect/2 callback on the server.

init "ws://localhost:4000/socket/websocket"
    |> withParams [ ( "token", "GYMXZwXzKFzfxyGntVkYt7uAJnscVnFJ" ) ]
onOpen : msg -> Socket msg -> Socket msg

Set a callback which will be called if the socket connection gets open.

( { code : Int
, reason : String
, wasClean : Bool
}
-> msg
)
-> Socket msg
-> Socket msg

Set a callback which will be called if the socket connection got closed. You can learn more about the code here.

map : (a -> b) -> Socket a -> Socket b

Composes each callback with the function a -> b.