Run a Foreign.JavaScript server.

Default configuration.

Port from environment variable or 8023, listening on localhost, no custom HTML, no static directory, logging to stderr, do reload on disconnect, buffer FFI calls.

Static configuration for a Foreign.JavaScript server.

This is a record type which has the following fields:

• jsPort :: Maybe Int

  Port number. Nothing means that the port number is read from the environment variable PORT. Alternatively, port 8023 is used if this variable is not set.

• jsAddr :: Maybe ByteString

  Bind address. Nothing means that the bind address is read from the environment variable ADDR. Alternatively, address 127.0.0.1 is used if this variable is not set.

• jsCustomHTML :: Maybe FilePath

  Custom HTML file to replace the default one.

• jsStatic :: Maybe FilePath

  Directory that is served under /static.

• jsLog :: ByteString -> IO ()

  Function to print a single log message.

• jsWindowReloadOnDisconnect :: Bool

  Reload the browser window if the connection to the server was dropped accidentally, for instance because the computer was put to sleep and awoken again.

• jsCallBufferMode :: CallBufferMode

  The initial CallBufferMode to use for runFunction. It can be changed at any time with setCallBufferMode.

• jsUseSSLBind :: Maybe ConfigSSL

  Whether to serve on a HTTPS connection instead of HTTP for improved security.

  • Just with a ConfigSSL to serve on HTTPS. Note that this will fail silently unless the snap-server package has been compiled with the openssl flag enabled.
  • Nothing to serve on HTTP.

(For reasons of forward compatibility, the constructor is not exported.)

Static configuration for the SSL version of the Foreign.JavaScript server.

This is a record type which has the following fields:

• jsSSLBind :: ByteString

  Bind address.

• jsSSLCert :: FilePath

  Path to SSL certificate file. Example: cert.pem.

• jsSSLChainCert :: Bool

  If it is SSL chain certificate file.

• jsSSLKey :: FilePath

  Path to SSL key file. Example: key.pem.

• jsSSLPort :: ByteString

  Port number. Example: 443.

Representation of a Foreign.JavaScript server.

Can be used for dynamic configuration, e.g. serving additional files.

MIME type.

URI type.

FIXME: Use the correct type from Network.URI

Begin to serve a local file with a given MimeType under a URI.

Begin to serve a local directory under a URI.

Representation of a browser window.

Server that the browser window communicates with.

Cookies that the browser window has sent to the server when connecting.

For the purpose of controlling garbage collection, every Window as an associated RemotePtr that is alive as long as the external JavaScript connection is alive.

Helper class for rendering Haskell values as JavaScript expressions.

Helper class for converting JavaScript values to Haskell values.

A JavaScript function with a given output type a.

A mutable JavaScript object.

Helper class for making ffi a variable argument function.

Simple JavaScript FFI with string substitution.

Inspired by the Fay language. https://github.com/faylang/fay/wiki

example :: String -> Int -> JSFunction String
example = ffi "$(%1).prop('checked',%2)"

The ffi function takes a string argument representing the JavaScript code to be executed on the client. Occurrences of the substrings %1 to %9 will be replaced by subequent arguments. The substring %% in the original will be replaced by % (character escape).

Note: Always specify a type signature! The types automate how values are marshalled between Haskell and JavaScript. The class instances for the FFI class show which conversions are supported.

Run a JavaScript function, but do not wait for a result.

NOTE: The JavaScript function need not be executed immediately, it can be buffered and sent to the browser window at a later time. See setCallBufferMode and flushCallBuffer for more.

Call a JavaScript function and wait for the result.

A mutable JavaScript object that has just been created. This a dummy type used for additional type safety.

Run a JavaScript function that creates a new object. Return a corresponding JSObject without waiting for the browser to send a result.

WARNING: This function assumes that the supplied JavaScript code does, in fact, create an object that is new.

Specification of how JavaScript functions should be called.

Set the call buffering mode for the given browser window.

Get the call buffering mode for the given browser window.

Flush the call buffer, i.e. send all outstanding JavaScript to the client in one single message.

Helper class for exporting Haskell functions to JavaScript as event handlers.

Export a Haskell function as an event handler.

The result is a JavaScript Function object that can be called from JavaScript like a regular function. However, the corresponding Haskell function will not be run immediately, rather it will be added to the event queue and processed like an event. In other words, this the Haskell code is only called asynchronously.

WARNING: The event handler will be garbage collected unless you keep a reference to it on the Haskell side! Registering it with a JavaScript function will generally not keep it alive.

Register an action to be performed when the client disconnects.

Send a debug message to the JavaScript console.

Print a timestamp and the time difference to the previous one in the JavaScript console.