Variable default

default: {
    check: ((name: string, callback: (() => boolean), response?:
        | Response
        | Response
        | Response
        | Response
        | Response) => boolean);
    env: (() => Record<string, string>);
    metadata: (() => Metadata);
    sleep: ((seconds: number) => void);
    step: ((name: string, callback: (() => void)) => any);
}

Type declaration

  • check: ((name: string, callback: (() => boolean), response?:
        | Response
        | Response
        | Response
        | Response
        | Response) => boolean)
      • (name, callback, response?): boolean

      • check 对请求返回的响应做进一步检查，判断结果成功与否

        import http from 'pts/http';
        import { check } from 'pts';

        export default function () {
            const resp = http.get('http://mockhttpbin.pts.svc.cluster.local/get');
            check('statusCode is 200', () => resp.statusCode === 200); // 设置检查点，以统计检查点指标
            check('statusCode is 200', () => resp.statusCode === 200, resp); // 设置检查点，统计检查点指标，并关联检查点与请求上下文
        };

        Parameters

        • name: string

          检查点的名字

        • callback: (() => boolean)

          用于检查的函数，该函数应返回 boolean 类型

            • (): boolean

            • Returns boolean

        • Optionalresponse:
              | Response
              | Response
              | Response
              | Response
              | Response

          （可选）传入被检查的请求的响应以关联检查点与请求上下文

        Returns boolean

        检查结果

  • env: (() => Record<string, string>)
      • (): Record<string, string>

      • env 返回压测任务的环境变量。

        import { env } from 'pts';

        export default function () {
          let env = env();
          console.log(env.PWD); // "/pts"
          console.log(env.DEBUG); // "true"
        }

        Returns Record<string, string>

        环境变量

  • metadata: (() => Metadata)
      • (): Metadata

      • metadata 返回压测任务的元数据。

        import { metadata } from 'pts';

        export default function () {
          let md = metadata();
          console.log(md.userID); // 123456
          console.log(md.appID); // 123456
          console.log(md.scenarioID); // scenario-xxxxxxxx
          console.log(md.region); // ap-guangzhou
          console.log(md.jobID); // job-xxxxxxxx
        }

        Returns Metadata

        元数据

  • sleep: ((seconds: number) => void)
      • (seconds): void

      • 在指定的时间内暂停 VU 执行。

        import { sleep } from 'pts';

        export default function () {
            sleep(1);
        };

        Parameters

        • seconds: number

          时间，单位秒

        Returns void

  • step: ((name: string, callback: (() => void)) => any)
      • (name, callback): any

      • 把压测场景分步骤，在压测报告中可以体现。

        import http from 'pts/http';
        import { step } from 'pts';

        export default function () {
            step('get', function () {
                http.get('http://mockhttpbin.pts.svc.cluster.local/get');
            })
        };

        Parameters

        • name: string

          名称

        • callback: (() => void)

          函数

            • (): void

            • Returns void

        Returns any

Settings

Member Visibility