bflow
v0.0.2
Published
bflow is a simple business workflow which is configable
Maintainers
Readme
busiflow-es6
make development more easy、relax and happy. busiflow-es6 是一个以配置为优先为核心概念的辅助库,核心目的只为打造全配置化的项目开发。
API
init(options)
初始化业务执行的一些基本配置options
- appName:[String] --应用名称
- busiLineConfigPath:[String|Array]--当前应用所有执行的业务流的配置文件地址,为了开发过程中的团队沟通方便等因素可以将配置文件拆开,然后用数组表示;(目前只支持.js和.json)
- busiProcessRoot:[String] --当前应用所有执行的业务流程处理器的根路径/根命名空间
- services:[Array]
- engine: [String] mysql|postgres|mongodb|redis|sqllite|oracle|sqlserver|rabbitmq|redis|webservice
- protocol:tcp|http|https
- package:[String(可选)] 待加载的包名(如果实现是在第三方的npm包的话则声明该包名)
- classPath:[String(可选)] 待加载的地址(当前项目目录内的)
- options:[Object]数据引擎连接的设置选项键值对象
- configFiles:[String|Array]--(可选)此engine模式下的当前应用所有流程过程中所需的配置文件地址(此文件的解析交由各自引擎解析处理,bflow不做任何相关解析)
- alias [String]插件别名--用于区分相同引擎的不同处理方式(请保证此值是唯一的)
- plug_dao:[Object|Array(Object)] :数据操作自定义/第三方模块
- engine: [String] mysql|postgres|mongodb|redis|sqllite|oracle|sqlserver
- package:[String(可选)] 待加载的包名(如果实现是在第三方的npm包的话则声明该包名)
- classPath:[String(可选)] 待加载的地址(当前项目目录内的)
- options:[Object]数据引擎连接的设置选项键值对象
- configFiles:[String|Array]--(可选)此engine模式下的当前应用所有流程过程中所需的数据操作命令的配置文件地址(此文件的解析交由各自引擎解析处理,bflow不做任何相关解析)
- alias [String]插件别名--用于区分相同引擎的不同处理方式(请保证此值是唯一的) note:package比classPath的优先级高,如果设置了package那么则不会再去读取classPath的地址
- plug_msgQueue:[Object|Array(Object)]:自定义/消息传输队列
- engine: [String] rabbitmq|redis
- package:[String(可选)] 待加载的包名(如果实现是在第三方的npm包的话则声明该包名)
- classPath:[String(可选)] 待加载的地址(当前项目目录内的)
- options:[String]通信连接的设置选项
- configFiles:[String|Array(可选)]--此engine模式下相关逻辑配置文件地址
- alias [String]插件别名--用于区分相同引擎的不同处理方式(请保证此值是唯一的)
- plug_webServ: 第三方接口调用定义[支付,] (主要通过http或https协议)
- alias: [String]插件别名--第三方接口名称(请保证此值是唯一的)
- ssl:[String] https设置- 如果此设置为空,那么默认采取http方式 2.1 key: 公钥地址 例: ssl-key.pem 2.2 cert: 证书地址 例: ssl-cert.pem
- url: [String] 第三方请求的url
- method: [String] 请求第三方地址的动作:'GET|POST|DELETE|PUT|OPTION',默认是GET
- configFiles:[String] 调用第三方接口所需参数配置文件地址
- encode:返回数据的编码格式 默认接收什么返回什么;
- category:第三方的类别 平台提供的如下: alipay|weixinpay|baidupay|jdpay|bankpay|voice|baidumap|googlemap
- plug_tcpServ:第三方tcp通讯服务(socket协议)
