Test.PagesProgram.SimulatedEffect

Simulated effects for testing. These parallel Elm's Cmd type but are inspectable by the test framework.

Use these with Effect.testPerform to decompose your Effect type into something the test framework can process.

import Test.PagesProgram.SimulatedEffect as SimulatedEffect




-- In your Effect module:
testPerform : Effect msg -> SimulatedEffect msg
testPerform effect =
    case effect of
        None ->
            SimulatedEffect.none


        Cmd _ ->
            -- Opaque Cmds cannot be simulated. Use simulateMsg
            -- in your test to inject the message manually.
            SimulatedEffect.none


        Batch list ->
            SimulatedEffect.batch (List.map testPerform list)


        SendMsg msg ->
            SimulatedEffect.dispatchMsg msg

type SimulatedEffect msg

= None

| Batch (List (SimulatedEffect msg))

| DispatchMsg msg

| SetField

{ formId : String

, name : String

, value : String

}

| SubmitFetcher (Fetcher msg)

A simulated effect that the test framework can inspect and execute.

None -- no effect
Batch -- multiple effects
DispatchMsg msg -- dispatch a message through the update cycle
SetField -- set a form field value
SubmitFetcher -- submit a fetcher (concurrent form submission)

none : SimulatedEffect msg

No effect. Parallels Effect.none.

Also use this for opaque Cmd values that cannot be simulated. Use simulateMsg in your test to inject the message that the Cmd would have produced.

batch : List (SimulatedEffect msg) -> SimulatedEffect msg

Combine multiple simulated effects. Parallels Effect.batch.

dispatchMsg : msg -> SimulatedEffect msg

Dispatch a message through the program's update cycle. This is the test-simulatable equivalent of Effect.sendMsg.

testPerform effect =
    case effect of
        SendMsg msg ->
            SimulatedEffect.dispatchMsg msg

setField :

{ formId : String

, name : String

, value : String

}

-> SimulatedEffect msg

Set a form field value. Parallels Effect.setField.

submitFetcher : Fetcher msg -> SimulatedEffect msg

Submit a fetcher for concurrent form submission. Parallels Effect.submitFetcher.

map : (a -> msg) -> SimulatedEffect a -> SimulatedEffect msg

Transform the messages produced by a simulated effect.

dillonkearns/elm-pages/12.2.0

Test.PagesProgram.SimulatedEffect

Modules