better-mock/src/types/index.ts

Forked from Mockjs. Generate random data & Intercept ajax request. Support miniprogram.

import { parse } from '../core/parser'

export type StringObject = {
  [key: string]: string;
} | {}

export interface MockedItem {
  rurl: string | RegExp | undefined;
  rtype: string | RegExp | undefined;
  template: object | Function | undefined;
}

export interface Mocked {
  [key: string]: MockedItem;
}

export interface XHRCustomOptions {
  url: string;
  type: string;
  body: XHRBody;
  headers: StringObject;
}

export type XHRBody = Document | BodyInit | null

export interface XHRCustom {
  events: {
    [event: string]: Function[];
  };
  requestHeaders: StringObject;
  responseHeaders: StringObject;
  timeout: number;
  options: Partial<XHRCustomOptions>;
  xhr: XMLHttpRequest;
  template: MockedItem | null;
  async: boolean;
}

export interface Settings {
  timeout: string | number;
}

export interface SchemaResult {
  name: string | number | undefined;
  template: object | string | (string | object)[];
  type: string;
  rule: ReturnType<typeof parse>;
  path: string[];
  items?: SchemaResult[];
  properties?: SchemaResult[];
}

export interface DiffResult {
  path: string[];
  type: string;
  actual: any;
  expected: any;
  action: string;
  message: string | undefined;
}