This module provides infrastructure for polling the status of processes that run longer than a single request-response lifecycle. To do this, we issue AJAX calls at regular intervals to a route that updates the status on the page. There are two main components necessary to use this library: splices and a handler.

The handler is a simple jobStatusHandler function. Typically you'll add it to your site's list of routes like this:

route [ ...
      , ("myJobStatus", jobStatusHandler "statusTemplate" ".statusDiv")
      , ...
      ]

The first argument to jobsHandler is the template that will be rendered for status update requests. It will typically be not much more than a <myJobStatus> tag enclosing the custom markup for displaying your job status. Here's an example using a bootstrap progress bar:

<myJobStatus interval="300">
  <ifRunning>
    <elapsedSeconds/> seconds elapsed

    <div class="progress">
      <div class="progress-bar progress-bar-striped active"  role="progressbar"
           aria-valuenow="${amountCompleted}" aria-valuemin="0"
           aria-valuemax="${amountTotal}" style="width: ${percentCompleted}%">
        <percentCompleted/>%
      </div>
    </div>

  </ifRunning>
  <ifFinished>
    <div class="progress">
      <div class="progress-bar progress-bar-striped"  role="progressbar"
           aria-valuenow="${amountCompleted}" aria-valuemin="0"
           aria-valuemax="${amountTotal}" style="width: ${percentCompleted}%">
        <percentCompleted/>%
      </div>
    </div>
  </ifFinished>
</myJobStatus>

This will poll for updates every 300 milliseconds. See the documentation for statusSplice for more details.

To get the above code working, you would have the myJobStatusPage handler return markup that contains something like this:

<h1>Status</h1>
<div class="statusdiv col-md-4">
  <apply template="statusTemplate"/>
</div>

You will also need to bind the main splice provided by this module.

splices = do
    ...
    "myJobStatus" MS.## statusSplice splices getUrl getMyJobStatus isFinished

You need to bind this splice once for each type of action that you are polling, each with its own splice name and function for getting the job status.