PackagesReroutesAboutlamdera.com

choonkeat/elm-webapp/3.0.1

NOTE: the latest version is 3.0.2

Formerly choonkeat/create-elm-server, choonkeat/elm-fullstack. Search finds this package by either name.

Rerouted (regenerated, verified). Same repository and tag, but GitHub now builds the zip with different bytes, so it no longer matches the SHA-1 package.elm-lang.org recorded. The Lamdera package server serves a copy recovered from https://github.com/choonkeat/elm-webapp.

What we checked: Tag 3.0.1 is still on github.com/choonkeat/elm-webapp; its commit 97b0974d1edb is from 2021-10-10 01:51 UTC, before the version was published (2021-10-10 01:52 UTC); elm.json is byte-identical to package.elm-lang.org's; the exposed modules match docs.json; the zip's SHA-1 is not the published one (GitHub's zip no longer comes out byte for byte the same), so the contents were checked instead.

The Lamdera compiler uses this copy and prints a one-line notice saying so. elm itself fails to download this version.

Details · package.elm-lang.org's zip: https://github.com/choonkeat/elm-webapp/zipball/3.0.1/

READMEAboutVersionsSourceModules

Webapp.Client

The README is better for getting an understanding and for getting started. In general we'd just use the code generated by elm-webapp cli without the need to reference here.

Definition

type alias Ports msg =
{ websocketConnected :
(Int -> FrameworkMsg msg) -> Sub (FrameworkMsg msg)
, websocketIn :
(String -> FrameworkMsg msg) -> Sub (FrameworkMsg msg)
}

Hook up ports to use websockets for passing serverMsg and clientMsg

websocketConnected port receives an Int for time now in milliseconds. Currently Webapp.Client does not use this information for anything.

websocketIn port receives the raw string from websocket event.data which will be parsed as a Result x serverMsg (see sendToServer)

type alias Protocol serverMsg clientMsg model msg x =
{ updateFromServer : serverMsg -> model -> ( model, Cmd msg )
, clientMsgEncoder : clientMsg -> Value
, serverMsgDecoder : Decoder serverMsg
, errorDecoder : Decoder x
, httpEndpoint : String
}

A set of required protocols.

- `updateFromServer` is called when `serverMsg` is received, e.g. as response of `sendToServer`
- `clientMsgEncoder` encodes outgoing `clientMsg`, e.g. via `sendToServer`
- `serverMsgDecoder` decodes replies from Server
- `errorDecoder` decodes error replies from Server
type alias Program flags model msg =
Program flags model (FrameworkMsg msg)

Exported type to enable apps to write their type signature of main, e.g.

main : Webapp.Client.Program Flags Model Msg
main =
    webapp.element

Common Helpers

{ element :
{ init : flags -> ( model, Cmd msg )
, view : model -> Html msg
, update : msg -> model -> ( model, Cmd msg )
, subscriptions : model -> Sub msg
}
, ports : Ports msg
, protocol : Protocol serverMsg clientMsg model msg x
}
-> { element : Program flags model (FrameworkMsg msg)
, sendToServer : clientMsg -> Task Error (Result x serverMsg)
}

Returns a Browser.element to use as main in your client app and a sendToServer function to send clientMsg with

main =
    webapp.element
{ document :
{ init : flags -> ( model, Cmd msg )
, view : model -> Document msg
, update : msg -> model -> ( model, Cmd msg )
, subscriptions : model -> Sub msg
}
, ports : Ports msg
, protocol : Protocol serverMsg clientMsg model msg x
}
-> { document : Program flags model (FrameworkMsg msg)
, sendToServer : clientMsg -> Task Error (Result x serverMsg)
}

Returns a Browser.document to use as main in your client app and a sendToServer function to send clientMsg with

main =
    webapp.document
{ application :
{ init : flags -> Url -> Key -> ( model, Cmd msg )
, view : model -> Document msg
, update : msg -> model -> ( model, Cmd msg )
, subscriptions : model -> Sub msg
, onUrlRequest : UrlRequest -> msg
, onUrlChange : Url -> msg
}
, ports : Ports msg
, protocol : Protocol serverMsg clientMsg model msg x
}
-> { application : Program flags model (FrameworkMsg msg)
, sendToServer : clientMsg -> Task Error (Result x serverMsg)
}

Returns a Browser.application to use as main in your client app and a sendToServer function to send clientMsg with

main =
    webapp.application

Modules

About this package serverReroutesreroutes.json
Pages and docs rendering from package.elm-lang.org, © 2012-2020 Evan Czaplicki. © 2026 Lamdera