Language.Javascript.JSaddle.Monad

JSM monad keeps track of the JavaScript context

Types

newtype JSM a

The JSM monad keeps track of the JavaScript execution context.

When using GHCJS it is IO.

Given a JSM function and a JSContextRef you can run the function like this...

runJSM jsmFunction javaScriptContext

Constructors

JSM

Fields

• unJSM :: ReaderT JSContextRef IO a

Instances

MonadFail JSM

Defined in Language.Javascript.JSaddle.Types

Methods

fail :: String -> JSM a

MonadFix JSM

Defined in Language.Javascript.JSaddle.Types

Methods

mfix :: (a -> JSM a) -> JSM a

MonadIO JSM

Defined in Language.Javascript.JSaddle.Types

Methods

liftIO :: IO a -> JSM a

Applicative JSM

Defined in Language.Javascript.JSaddle.Types

Methods

pure :: a -> JSM a

(<*>) :: JSM (a -> b) -> JSM a -> JSM b

liftA2 :: (a -> b -> c) -> JSM a -> JSM b -> JSM c

(*>) :: JSM a -> JSM b -> JSM b

(<*) :: JSM a -> JSM b -> JSM a

Functor JSM

Defined in Language.Javascript.JSaddle.Types

Methods

fmap :: (a -> b) -> JSM a -> JSM b

(<$) :: a -> JSM b -> JSM a

Monad JSM

Defined in Language.Javascript.JSaddle.Types

Methods

(>>=) :: JSM a -> (a -> JSM b) -> JSM b

(>>) :: JSM a -> JSM b -> JSM b

return :: a -> JSM a

MonadCatch JSM

Defined in Language.Javascript.JSaddle.Types

Methods

catch :: (HasCallStack, Exception e) => JSM a -> (e -> JSM a) -> JSM a

MonadMask JSM

Defined in Language.Javascript.JSaddle.Types

Methods

mask :: HasCallStack => ((forall a. JSM a -> JSM a) -> JSM b) -> JSM b

uninterruptibleMask :: HasCallStack => ((forall a. JSM a -> JSM a) -> JSM b) -> JSM b

generalBracket :: HasCallStack => JSM a -> (a -> ExitCase b -> JSM c) -> (a -> JSM b) -> JSM (b, c)

MonadThrow JSM

Defined in Language.Javascript.JSaddle.Types

Methods

throwM :: (HasCallStack, Exception e) => e -> JSM a

ToJSVal JSCallAsFunction

A callback to Haskell can be used as a JavaScript value. This will create an anonymous JavaScript function object. Use function to create one with a name.

Defined in Language.Javascript.JSaddle.Object

Methods

toJSVal :: JSCallAsFunction -> JSM JSVal

toJSValListOf :: [JSCallAsFunction] -> JSM JSVal

MakeArgs JSCallAsFunction

Defined in Language.Javascript.JSaddle.Object

Methods

makeArgs :: JSCallAsFunction -> JSM [JSVal]

MonadJSM JSM

Defined in Language.Javascript.JSaddle.Types

Methods

liftJSM' :: JSM a -> JSM a

MonadAtomicRef JSM

Defined in Language.Javascript.JSaddle.Types

Methods

atomicModifyRef :: Ref JSM a -> (a -> (a, b)) -> JSM b

atomicModifyRef' :: Ref JSM a -> (a -> (a, b)) -> JSM b

MonadRef JSM

Defined in Language.Javascript.JSaddle.Types

Associated Types

type Ref JSM :: Type -> Type

Methods

newRef :: a -> JSM (Ref JSM a)

readRef :: Ref JSM a -> JSM a

writeRef :: Ref JSM a -> a -> JSM ()

modifyRef :: Ref JSM a -> (a -> a) -> JSM ()

modifyRef' :: Ref JSM a -> (a -> a) -> JSM ()

MonadUnliftIO JSM

Defined in Language.Javascript.JSaddle.Types

Methods

withRunInIO :: ((forall a. JSM a -> IO a) -> IO b) -> JSM b

ToJSVal v => ToJSVal (JSM v)

JSVal can be made by evaluating a function in JSM as long as it returns something we can make into a JSVal.

Defined in Language.Javascript.JSaddle.Value

Methods

toJSVal :: JSM v -> JSM JSVal

toJSValListOf :: [JSM v] -> JSM JSVal

MakeArgs arg => MakeArgs (JSM arg)

Defined in Language.Javascript.JSaddle.Classes.Internal

Methods

makeArgs :: JSM arg -> JSM [JSVal]

MakeObject v => MakeObject (JSM v)

Object can be made by evaluating a function in JSM as long as it returns something we can make into a Object.

Defined in Language.Javascript.JSaddle.Object

Methods

makeObject :: JSM v -> JSM Object

type Ref JSM

Defined in Language.Javascript.JSaddle.Types

type Ref JSM = Ref IO

data JSContextRef

Identifies a JavaScript execution context. When using GHCJS this is just () since their is only one context. When using GHC it includes the functions JSaddle needs to communicate with the JavaScript context.

class (Applicative m, MonadIO m) => MonadJSM m

The MonadJSM is to JSM what MonadIO is to IO. When using GHCJS it is MonadIO.

Instances

MonadJSM JSM

Defined in Language.Javascript.JSaddle.Types

Methods

liftJSM' :: JSM a -> JSM a

MonadJSM m => MonadJSM (MaybeT m)

Defined in Language.Javascript.JSaddle.Types

Methods

liftJSM' :: JSM a -> MaybeT m a

MonadJSM m => MonadJSM (ExceptT e m)

Defined in Language.Javascript.JSaddle.Types

Methods

liftJSM' :: JSM a -> ExceptT e m a

MonadJSM m => MonadJSM (IdentityT m)

Defined in Language.Javascript.JSaddle.Types

Methods

liftJSM' :: JSM a -> IdentityT m a

MonadJSM m => MonadJSM (ReaderT r m)

Defined in Language.Javascript.JSaddle.Types

Methods

liftJSM' :: JSM a -> ReaderT r m a

MonadJSM m => MonadJSM (StateT s m)

Defined in Language.Javascript.JSaddle.Types

Methods

liftJSM' :: JSM a -> StateT s m a

MonadJSM m => MonadJSM (StateT s m)

Defined in Language.Javascript.JSaddle.Types

Methods

liftJSM' :: JSM a -> StateT s m a

(Monoid w, MonadJSM m) => MonadJSM (WriterT w m)

Defined in Language.Javascript.JSaddle.Types

Methods

liftJSM' :: JSM a -> WriterT w m a

(Monoid w, MonadJSM m) => MonadJSM (WriterT w m)

Defined in Language.Javascript.JSaddle.Types

Methods

liftJSM' :: JSM a -> WriterT w m a

MonadJSM m => MonadJSM (ContT r m)

Defined in Language.Javascript.JSaddle.Types

Methods

liftJSM' :: JSM a -> ContT r m a

(Monoid w, MonadJSM m) => MonadJSM (RWST r w s m)

Defined in Language.Javascript.JSaddle.Types

Methods

liftJSM' :: JSM a -> RWST r w s m a

(Monoid w, MonadJSM m) => MonadJSM (RWST r w s m)

Defined in Language.Javascript.JSaddle.Types

Methods

liftJSM' :: JSM a -> RWST r w s m a

liftJSM :: MonadJSM m => JSM a -> m a

The liftJSM is to JSM what liftIO is to IO. When using GHCJS it is liftIO.

Running JavaScript in a JavaScript context

askJSM :: MonadJSM m => m JSContextRef

Gets the JavaScript context from the monad

runJSM :: MonadIO m => JSM a -> JSContextRef -> m a

Runs a JSM JavaScript function in a given JavaScript context.

runJSaddle :: MonadIO m => JSContextRef -> JSM a -> m a

Alternative version of runJSM

Syncronizing with the JavaScript context

syncPoint :: JSM ()

Forces execution of pending asyncronous code

syncAfter :: JSM a -> JSM a

Forces execution of pending asyncronous code after performing f

waitForAnimationFrame :: JSM Double

On GHCJS this is waitForAnimationFrame. On GHC it will delay the execution of the current batch of asynchronous command when they are sent to JavaScript. It will not delay the Haskell code execution. The time returned will be based on the Haskell clock (not the JavaScript clock).

nextAnimationFrame :: (Double -> JSM a) -> JSM a

Tries to executes the given code in the next animation frame callback. Avoid synchronous opperations where possible.

Exception Handling

catch :: (MonadCatch m, HasCallStack, Exception e) => m a -> (e -> m a) -> m a

Provide a handler for exceptions thrown during execution of the first action. Note that type of the type of the argument to the handler will constrain which exceptions are caught. See Control.Exception's catch.

bracket :: (HasCallStack, MonadMask m) => m a -> (a -> m c) -> (a -> m b) -> m b

Generalized abstracted pattern of safe resource acquisition and release in the face of errors. The first action "acquires" some value, which is "released" by the second action at the end. The third action "uses" the value and its result is the result of the bracket.

If an error is thrown during the use, the release still happens before the error is rethrown.

Note that this is essentially a type-specialized version of generalBracket. This function has a more common signature (matching the signature from Control.Exception), and is often more convenient to use. By contrast, generalBracket is more expressive, allowing us to implement other functions like bracketOnError.