# MatmanResult 对象

Matman 运行之后返回的格式化的结果，提供一些便捷的函数，帮助大家进行判断。

# 1. 结果对象

处理之后的数据如下：

interface Result {
  // 使用的 Runner 的名称
  runnerName: string;
  // 页面爬虫返回的真实数据
  data: unknown[];
  // 全局监听到的请求等事件
  globalInfo: {
    recorder?: {
      queue: MatmanResultQueueItem[];
      allRequestUrl: string[];
    };
    isExistCoverageReport?: boolean;
  };
  // 名称索引映射
  readonly dataIndexMap;
  readonly queueHandler;
}

# 2. 内建方法

# 2.1 toString

将对象中的数据转化为 JSON 字符串

toString(): string;

# 2.1.1 参数

  • none

# 2.1.2 返回值

JSON 字符串

# 2.2 get

通过测试动作名字或者动作的索引（不推荐）获得数据

get(actionName: string | number): unknown

# 2.2.1 参数

  • actionName：测试动作名字，可以是自定义的名字，也可以是数组索引（string 或者 number）

# 2.2.2 返回值

指定的爬虫数据

# 2.3 getQueue

获得捕获到的请求队列

getQueue(): MatmanResultQueueItem[];

# 2.3.1 参数

  • none

# 2.3.2 返回值

请求队列 MatmanResultQueueItem 数组

# 2.4 getNetwork

从结果队列中过滤出网络请求

getNetwork(resourceType?: ResourceType): MatmanResultQueueItem[];

# 2.4.1 参数

  • resourceType：资源类型，定义如下：
/**
 * nightmare 资源类型的枚举，详见 nightmare-handler 组件中的 RESOURCE_TYPE
 */
declare type NightmareResourceType = 'mainFrame' | 'subFrame' | 'stylesheet' | 'script' | 'image' | 'object' | 'xhr' | 'other' | '';
/**
 * puppeteer 资源类型的枚举
 * https://github.com/puppeteer/puppeteer/blob/v4.0.0/docs/api.md#httprequestresourcetype
 */
declare type PuppeteerResourceType = 'document' | 'stylesheet' | 'image' | 'media' | 'font' | 'script' | 'texttrack' | 'xhr' | 'fetch' | 'eventsource' | 'websocket' | 'manifest' | 'other' | '';
export declare type ResourceType = PuppeteerResourceType | NightmareResourceType;

# 2.4.2 返回值

请求队列 MatmanResultQueueItem 数组

# 2.5 isExistInNetwork

通过传入的参数判断是否存在某个网络请求

isExistInNetwork(
  partialURL: string,
  query?: { [key: string]: any },
  resourceType?: ResourceType,
  status?: number,
): boolean;

# 2.5.1 参数

  • partialURL：请求的 URL
  • query：查询参数（可选）
  • resourceType：资源类型（可选）
  • status：状态（可选）

# 2.5.2 返回值

Boolean

# 2.6 isExistPage

是否存在某个页面

isExistPage(partialURL: string, query?: { [key: string]: any }, status?: number): boolean;

# 2.6.1 参数

  • partialURL：请求的 URL
  • query：查询参数（可选）
  • status：状态（可选）

# 2.6.2 返回值

Boolean

# 2.7 isExistXHR

是否存在某个 xhr 请求

isExistXHR(partialURL: string, query?: { [key: string]: any }, status?: number): boolean;

# 2.7.1 参数

  • partialURL：请求的 URL
  • query：查询参数（可选）
  • status：状态（可选）

# 2.7.2 返回值

Boolean

# 2.8 isExistImage

是否存在某个 image 请求

isExistImage(partialURL: string, query?: { [key: string]: any }, status?: number): boolean;

# 2.8.1 参数

  • partialURL：请求的 URL
  • query：查询参数（可选）
  • status：状态（可选）

# 2.8.2 返回值

Boolean

# 2.9 isExistStylesheet

是否存在某个对 CSS 样式表的请求

isExistStylesheet(partialURL: string, query?: { [key: string]: any }, status?: number): boolean;

# 2.9.1 参数

  • partialURL：请求的 URL
  • query：查询参数（可选）
  • status：状态（可选）

# 2.9.2 返回值

Boolean

# 2.10 isExistScript

是否存在某个 script 请求

isExistScript(partialURL: string, query?: { [key: string]: any }, status?: number): boolean;

# 2.10.1 参数

  • partialURL：请求的 URL
  • query：查询参数（可选）
  • status：状态（可选）

# 2.10.2 返回值

Boolean

# 2.11 isExistJSBridge

是否存在某个 JSBridge 的调用

isExistJSBridge(partialURL: string, query?: { [key: string]: any }): boolean;

# 2.11.1 参数

  • partialURL：请求的 URL
  • query：查询参数（可选）

# 2.11.2 返回值

Boolean

# 2.11.3 使用注意

因为一些实现的问题，在使用中这个 API 可能会对用户代码有一定的侵入性。

如果在使用中发现此 API 的调用结果与实现不符，那么请检查结果文件。如果在 URL 列表中没有捕捉到指定的调用，我们需要大家在代码中添加如下语句：

console.log(`[e2e] ${url}`)

这样输出在控制台的这条 URL 将被认为是 JSBridge 调用。

# 2.12 isExistJSConsole

是否存在某个 console 输出

isExistConsole(partialText: string | RegExp, type?: string, isFullMatch?: boolean): boolean;

# 2.12.1 参数

  • partialText：需要匹配的 string 或者 正则表达式
  • type：console 的类型，如：log、error 等
  • isFullMatch：是否采用完全匹配模式

# 2.12.2 返回值

Boolean

← 爬虫工具：web-crawl-util →