Git Product home page Git Product logo

sub-processor's Introduction

sub-processor

Build Status codecov

NPM

Installation

npm install --save sub-processor

Example

// sub.js
// 建议这个包引用node_modules中的一些cpu密集型处理任务
const { Base } = require('sub-processor');
module.exports = class Sub extends Base {
  handler(arg1, arg2) {
    // do something and return with promise or return directly  
  }
};
const { Processor } = require('sub-processor');
const processor = new Processor({moduleFullPath: `fullPathToModule/sub.js`});

processor.on('error', (err) => {
  // do something
});

processor
  .exec(arg1, arg2)
  .then((result) => {
    // result of running sub.js 
  })
  .catch((err) => {
    // running errored
  })
  .then(() => processor.dispose());

Document

class Base

异步执行的包需要继承于该基类,基类提供一些基础方法

instance method

  • init():Promise<void> 如果需要在执行之前先异步初始化一些内容,覆盖该方法并返回promise, 外部调用将会等到promise执行完成之后再进行.
  • handler():Promise<*> 主方法,执行的业务逻辑放在这里,返回结果异步同步都可以.
  • dispose():Promise<void> 外部dispose时,会向子进程发送SIGINT信号,并调用该方法,如果有需要异步处理的关闭操作,覆盖该方法,并返回promise.

class Processor

  • constructor([options]) 实例方法
    • options.moduleFullPath string 执行脚本的完整路径
    • options.timeout number (default: 10 * 1000) 单次执行超时时间
    • options.forkOptions object (default: {}) child_process.fork的options

instance method

  • exec(...args):Promise<*> 异步调用包,这里传递的args将会以相同的方式传递给脚本的handler方法
  • dispose():Promise<void> 销毁当前子进程

sub-processor's People

Contributors

marvinwilliam avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.