apeman-app-ssedeprecated

apeman app for sse (Server-Sent Events)

Usage no npm install needed!

<script type="module">
  import apemanAppSse from 'https://cdn.skypack.dev/apeman-app-sse';
</script>

README

apeman-app-sse

Build Status Code Climate Code Coverage npm Version JS Standard

apeman app for sse (Server-Sent Events)

Installation

$ npm install apeman-app-sse --save

Usage

  1. Define an app within Apemanfile.js
  2. Call the app via apeman app command.

Apemanfile.js

/** This is an example Apemanfile to use apeman-app-sse */

'use strict'

module.exports = {
  $pkg: { /* ... */ },
  $apps: {
    // Define your own app.
    'my-app-01': {
      // Map url and handlers.
      '/my-sse': [
        require('apeman-app-sse')(
          (client) => {
            client.send({
              event: 'greeting',
              data: 'hi,there'
            })
            client.on('close', () => {
              /* ... */
            })
          },
          {
            // Options
          })
      ]
    }
  }
}

Then,

$ apeman app my-app-01 -p 3000

Client slide script

'use strict'

const EventSource = require('eventsource')

let es = new EventSource('/my-sse')
es.addEventListener('greeting', (e) => {
  console.log(e.data) // -> 'hi,there'
})

Signature

apemanAppSse(handler, options) -> function

apeman app for sse (Server-Sent Events)

Args
Name Type Default Description
handler function SSE Client handler
options object Optional settings.

License

This software is released under the MIT License.

Links