-----------------------------------------------------------------------------
{-# LANGUAGE CPP                        #-}
-----------------------------------------------------------------------------
-- |
-- Module      :  Miso.EventSource
-- Copyright   :  (C) 2016-2026 David M. Johnson
-- License     :  BSD3-style (see the file LICENSE)
-- Maintainer  :  David M. Johnson <code@dmj.io>
-- Stability   :  experimental
-- Portability :  non-portable
--
-- Functions and types for working with [Server Sent Events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events)
--
----------------------------------------------------------------------------
module Miso.EventSource
  ( -- *** EventSource
    connectText
  , connectJSON
  , close
  , socketState
  -- *** Defaults
  , emptyEventSource
  -- *** Types
  , EventSource (..)
  , URL
  -- *** Re-exports
  , Payload (..)
  ) where
-----------------------------------------------------------------------------
import           Miso.JSON
-----------------------------------------------------------------------------
import           Miso.Effect
import           Miso.Runtime
import           Miso.String
-----------------------------------------------------------------------------
-- | <https://developer.mozilla.org/en-US/docs/Web/API/EventSource>
connectText
  :: URL
  -> (EventSource -> action)
  -- ^ onOpen
  -> (MisoString -> action)
  -- ^ onMessage
  -> (MisoString -> action)
  -- ^ onError
  -> Effect parent props model action
connectText :: forall action parent props model.
URL
-> (EventSource -> action)
-> (URL -> action)
-> (URL -> action)
-> Effect parent props model action
connectText = URL
-> (EventSource -> action)
-> (URL -> action)
-> (URL -> action)
-> Effect parent props model action
forall action parent props model.
URL
-> (EventSource -> action)
-> (URL -> action)
-> (URL -> action)
-> Effect parent props model action
eventSourceConnectText
-----------------------------------------------------------------------------
-- | <https://developer.mozilla.org/en-US/docs/Web/API/EventSource>
connectJSON
  :: FromJSON value
  => URL
  -> (EventSource -> action)
  -- ^ onOpen
  -> (value -> action)
  -- ^ onMessage
  -> (MisoString -> action)
  -- ^ onError
  -> Effect parent props model action
connectJSON :: forall value action parent props model.
FromJSON value =>
URL
-> (EventSource -> action)
-> (value -> action)
-> (URL -> action)
-> Effect parent props model action
connectJSON = URL
-> (EventSource -> action)
-> (value -> action)
-> (URL -> action)
-> Effect parent props model action
forall value action parent props model.
FromJSON value =>
URL
-> (EventSource -> action)
-> (value -> action)
-> (URL -> action)
-> Effect parent props model action
eventSourceConnectJSON
-----------------------------------------------------------------------------
-- | <https://developer.mozilla.org/en-US/docs/Web/API/EventSource/close>
close
  :: EventSource
  -> Effect parent props model action
close :: forall parent props model action.
EventSource -> Effect parent props model action
close = EventSource -> Effect parent props model action
forall parent props model action.
EventSource -> Effect parent props model action
eventSourceClose
-----------------------------------------------------------------------------