IOTA >> program-generator>> 返回
项目作者： iftt

项目描述 ：
Use the program generator to quickly and autonomously listen to specific changes in new services from server input.
高级语言： JavaScript
项目地址: git://github.com/iftt/program-generator.git
创建时间： 2019-04-04T20:11:15Z
项目社区：https://github.com/iftt/program-generator
开源协议：ISC License
下载


program-generator travis @iftt/program-generator"">npm @iftt/program-generator"">downloads JavaScript Style Guide

About

The program generator module takes a specified instruction set and handles managing all new MaM data coming into the stream. If a new message triggers the the “program”, it posts an action.

Install

  1. # npm
  2. npm install --save @iftt/program-generator
  4. # yarn
  5. yarn add @iftt/program-generator

How to Use

NOTE: This module assumes the MaM module @iftt/mam has already been instantiated with a provider and ready to request/post messages from/to said provider.

  1. // ES6
  2. import ProgramGenerator from '@iftt/program-generator'
  3. // ES5
  4. const ProgramGenerator = require('@iftt/program-generator').default
  6. // grab the instruction set:
  7. const weatherProgram = require('./test/weatherProgram.json')
  9. const programGenerator = new ProgramGenerator(weatherProgram) // using the default 5 second delay
  11. programGenerator.on('action', action => {
  12.   // do stuff
  13. })

Debug

If you need to debug this module use the string program-generator

  1. DEBUG=program-generator node x

API

Type Service

  1. type Service = {
  2.   protocol: { string: { string: any } },
  3.   getRoot: string
  4. }

Type Program

  1. type Program = {
  2.   condition: Object,
  3.   action: { key: string, value: any }
  4. }

Type Instructions

  1. type Instructions = {
  2.   service: Service,
  3.   program: Program
  4. }

new ProgramGenerator (instructions: Instructions, intervalTime?: number = 5000): ProgramGenerator extends EventEmitter

  • instructions: Instructions instruction set to create the program
  • [intervalTime]: number defaults to 5,000 milliseconds (5 seconds); timeout until checking if the latest MaM message update

deconstruct (): void

  • null: void used to remove any active intervals looking for new messages

getRoot (): string

  • null: string returns the current root of the MaM

Event: ‘action’

  • triggered when a instruction specified action has changed

ISC License (ISC)

Copyright 2019
Copyright (c) 2004-2010 by Internet Systems Consortium, Inc. (“ISC”)
Copyright (c) 1995-2003 by Internet Software Consortium

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.