CookiePlugin

CookiePlugin

请求管理-cookie插件
在请求前后植入cookie逻辑，详见[基础能力] cookie机制

Constructor

new CookiePlugin(pluginNameopt, cookie)

Source:

构造函数

Parameters:
Name Type Attributes Default Description
pluginName string <optional>
 'CookiePlugin'

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

cookie管理器

Extends

Members

Source:

cookie管理器

Type:

pluginName :string

Source:
Overrides:

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

Type:
  • string

requester :Requester

Source:
Overrides:

请求管理器

Type:

Methods

afterRequest(reqOptions, reqRes)

Source:
Overrides:

接收返回结果头部中的cookie信息

Parameters:
Name Type Description
reqOptions Requester~ReqOptions
reqRes Requester~ReqRes

(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, requester)

Source:
Overrides:

在请求头中注入cookie信息

Parameters:
Name Type Description
reqOptions Requester~ReqOptions
requester Requester

(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对象