InstantPlugin

InstantPlugin

请求管理-快捷插件
在请求前后植入指定处理逻辑，详见[基础能力] 灵活易扩展的请求管理

Constructor

new InstantPlugin(options)

Source:

构造函数
直接传入钩子函数，快速实现定制逻辑，而不用每次单独写一个子类
适用场景：逻辑特别轻巧、逻辑为第三方传入等

Parameters:
Name Type Description
options object
Properties
Name Type Attributes Description
pluginName string

插件名称，主要用于打印日志和调试，便于追溯操作源
beforeRequest function <optional>

钩子函数，详见BasePlugin#beforeRequest
beforeRequestAsync function <optional>

钩子函数，详见BasePlugin#beforeRequestAsync
afterRequest function <optional>

钩子函数，详见BasePlugin#afterRequest
afterRequestAsync function <optional>

钩子函数，详见BasePlugin#afterRequestAsync

Extends

Members

pluginName :string

Source:
Overrides:

插件名称，主要用于打印日志和调试，便于追溯操作源

Type:
  • string

requester :Requester

Source:
Overrides:

请求管理器

Type:

Methods

afterRequest(reqOptions, thisIssuer, reqRes) → {undefined|Requester~AfterRequestRes}

Source:
Overrides:

钩子函数，请求返回之后调用，同步
不会等待异步操作返回，如需等待异步逻辑，请改用BasePlugin#afterRequestAsync

Parameters:
Name Type Description
reqOptions Requester~ReqOptions

请求参数
thisIssuer object

发起接口请求的this对象
reqRes Requester~ReqRes

请求结果
Returns:

期望的后续处理，undefined表示继续执行默认流程

Type
undefined | Requester~AfterRequestRes

(async) afterRequestAsync(reqOptions, thisIssuer, reqRes) → {undefined|Requester~AfterRequestRes}

Source:
Overrides:

钩子函数，请求返回之后调用，异步
会等待async函数resolve，若无异步逻辑，建议使用BasePlugin#afterRequest

Parameters:
Name Type Description
reqOptions Requester~ReqOptions

请求参数
thisIssuer object

发起接口请求的this对象
reqRes Requester~ReqRes

请求结果
Returns:

期望的后续处理，undefined表示继续执行默认流程

Type
undefined | Requester~AfterRequestRes

beforeRequest(reqOptions, thisIssuer) → {undefined|Requester~BeforeRequestRes}

Source:
Overrides:

钩子函数，发请求之前调用，同步
不会等待异步操作返回，如需等待异步逻辑，请改用BasePlugin#beforeRequestAsync

Parameters:
Name Type Description
reqOptions Requester~ReqOptions

请求参数
thisIssuer object

发起接口请求的this对象
Returns:

期望的后续处理，undefined表示继续执行默认流程

Type
undefined | Requester~BeforeRequestRes

(async) beforeRequestAsync(reqOptions, thisIssuer) → {undefined|Requester~BeforeRequestRes}

Source:
Overrides:

钩子函数，发请求之前调用，异步
会等待async函数resolve，若无异步逻辑，建议使用BasePlugin#beforeRequest

Parameters:
Name Type Description
reqOptions Requester~ReqOptions

请求参数
thisIssuer object

发起接口请求的this对象
Returns:

期望的后续处理，undefined表示继续执行默认流程

Type
undefined | Requester~BeforeRequestRes

mount(requester)

Source:
Overrides:

钩子函数，插件被挂载到requester对象上时触发

Parameters:
Name Type Description
requester Requester

被挂载到的requester对象