@hive/handler

对外部访问的api的handler

Syntax

const Handler=require('@hive/handler');

var handler = new Handler(config);

Constructor

new Handler( Object config )

Parameters

• config

  • api

    String : handler的监控url, 绝对路径

  • type

    String [ 'get' | 'post' ] : default is 'get'

  • params

    Params : @hive/params的对象, handler的接受参数列表

  • render

    GeneratorFunction : 会传入一个参数对象, 由Params格式化之后的参数对象, 返回为结果值

    注:这里有一个约定, 如果出错, 请返回@hive/error的对象

  • usage

    String : handler的功能描述, 推荐描述中增加返回样例

  • questingTimeout

    Number : 重复请求的间隔时限, 即在第一个请求还未返回之前, 在定义的时间内又发送了第二个同参数请求, 则会同第一个请求一同返回结果, 不会重复请求

    默认值为5000, 单位为毫秒

  • cache

    [ true | false | Number ]

    注: 这项是数据缓存配置, 默认值为false

    true为参数一致的情况下, 永久缓存

    false为不缓存

    Number为缓存的毫秒值

  • timeout (default false)

    Number | false : handler的超时时间, 单位为秒, false为无超时时间

Properties

• api (readonly)

  监控的api

• type

  [ 'get' | 'post' ]

• params (readonly)

  handler所接受的参数列表

• render (readonly)

  传入的render

• usage (readonly)

  handler的功能描述

• cache

  缓存配置, @hive/cache的对象

• questing

  正在请求中的请求, @hive/cache的对象

• questingTimeout

  重复请求间隔时限

• timeout

  超时时间

Methods

• getUsage

  获取当前api的usage对象

• * handle(Object args)

  GeneratorFunction 返回处理完的api返回数据