polling-emitter

polling-emitter

Polls data from any source at given interval and fires events on changes.

Installation

npm install --save polling-emitter@^4.0.1

yarn add polling-emitter@^4.0.1

Try it out

Open a browser's JavaScript console and execute:

const scriptElement = document.createElement("script");
scriptElement.setAttribute("type","text/javascript");
scriptElement.setAttribute("src","https://unpkg.com/polling-emitter@4.0.1");
document.querySelector("head").appendChild(scriptElement);

This module is now loaded in a variable that can be accessed in any scope.

typeof PollingEmitter.default

Documentation

• polling-emitter
  • module.exports ⇐ EventEmitter ⏏
    • new module.exports(options)
    • instance
      • .options : Options
      • .processedEntryIds : Set.<string>
      • .successfulRunsCount : number
      • .isRunning : boolean
      • .hasProcessEntryFunction : boolean
      • .hasHandleErrorFunction : boolean
      • .start()
      • .hasAlreadyProcessedEntry(entry) ⇒ boolean
      • .hasAlreadyProcessedEntryId(entryId) ⇒ boolean
      • .stop()
    • inner
      • ~Options : Object

Polls data from any source at given interval and fires events on changes.

Kind: Exported class
Extends: EventEmitter

Param	Type
options	Options

Example

import PollingEmitter from "polling-emitter"
const emitter = PollingEmitter()

Kind: instance property of module.exports
Read only: true
Kind: instance property of module.exports
Kind: instance property of module.exports
Kind: instance property of module.exports
Kind: instance property of module.exports
Kind: instance property of module.exports
Kind: instance method of module.exports
Emits: PollingEmitter#event:newEntry
Kind: instance method of module.exports

Param	Type
entry	Object

Kind: instance method of module.exports

Param	Type
entryId	string

Kind: instance method of module.exports
Kind: inner typedef of module.exports
Properties

Name	Type	Default
[pollInterval]	number	60000
[invalidateInitialEntries]	boolean	false
[autostart]	boolean	true
[getIdFromEntry]	function	(entry) => entry.id
[processEntry]	function
fetchEntries	function

License

MIT License

Copyright © 2019, Jaid <[e-mail]> (github.com/jaid)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.