Phoenix.Config

Defines the Config for Phoenix

Definition

type alias Config msg parentModel channelsModel =

{ parentMsg : Msg msg -> msg

, ports : Maybe (Ports msg)

, socket : parentModel -> Socket msg

, modelGetter : parentModel -> Model msg channelsModel

, modelSetter : Model msg channelsModel -> parentModel -> parentModel

, channelsBuilder : ChannelsBuilder msg channelsModel

, channelsModelComparator : ChannelsModelComparator channelsModel

, channelsModelBuilder : parentModel -> channelsModel

, debug : Bool

}

The config for Phoenix

type alias PushConfig msg =

{ parentMsg : Msg msg -> msg

, debug : Bool

}

Minimal config needed for Phoenix.push

type alias PushableConfig msg a =

{ a | parentMsg : Msg msg -> msg }

Extensible config type used by Phoenix.push

Helpers

new :

(Msg msg -> msg)

-> Ports msg

-> (parentModel -> Socket msg)

-> (parentModel -> Model msg channelsModel)

-> (Model msg channelsModel -> parentModel -> parentModel)

-> { parentMsg : Msg msg -> msg

, ports : Maybe (Ports msg)

, socket : parentModel -> Socket msg

, modelGetter : parentModel -> Model msg channelsModel

, modelSetter : Model msg channelsModel -> parentModel -> parentModel

}

Creates a new config. The output of this must be piped into withStaticChannels or withDynamicChannels

withStaticChannels :

List (Channel msg)

-> { parentMsg : Msg msg -> msg

, ports : Maybe (Ports msg)

, socket : parentModel -> Socket msg

, modelGetter : parentModel -> Model msg ()

, modelSetter : Model msg () -> parentModel -> parentModel

}

-> Config msg parentModel ()

Sets the config to connect to a list of static channels.

withDynamicChannels :

ChannelsBuilder msg channelsModel

-> (parentModel -> channelsModel)

-> { parentMsg : Msg msg -> msg

, ports : Maybe (Ports msg)

, socket : parentModel -> Socket msg

, modelGetter : parentModel -> Model msg channelsModel

, modelSetter : Model msg channelsModel -> parentModel -> parentModel

}

-> Config msg parentModel channelsModel

Sets the config to allow the use of dynamic channels

withChannelsModelComparator :

ChannelsModelComparator channelsModel

-> Config msg parentModel channelsModel

As an optimisation, the library compares the passed channels model with the version from the previous functional call and then only calls the provided channels function if the model has changed. This comparison is done by default with == and due to an issue in Elm, comparing a model with a contained Json.Encode.Value can cause a runtime exception. (See https://github.com/elm/core/issues/1058). To solve this, you can provide a custom function that will compare channels models safely.

withDebug :

Config msg parentModel channelsModel

-> Config msg parentModel channelsModel

Enable debug logs. Every incoming and outgoing message will be printed.

toPushConfig : Config msg parentModel channelsModel -> PushConfig msg

Create a config that can be used for Phoenix.push from the config. This has a simple type and is useful if used in a multi-page app with delegating update functions.

mapPushConfig : (Msg m2 -> m2) -> PushConfig m1 -> PushConfig m2

Maps the push config

chazsconi/elm-phoenix-ports/2.1.0

Phoenix.Config

Definition

Helpers

Modules