2.0.0 • Published 10 years ago

apeman-app-sse v2.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
10 years ago

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
NameTypeDefaultDescription
handlerfunctionSSE Client handler
optionsobjectOptional settings.

License

This software is released under the MIT License.

Links

2.0.0

10 years ago

1.2.1

10 years ago

1.2.0

10 years ago

1.0.1

10 years ago

1.0.0

10 years ago