Variable defaultConst

default: {
    FormData: (new () => {
        append(key: string, value: string | File): void;
        body(): ArrayBuffer;
        contentType(): string;
    });
    batch(requests: Request[], opt?: BatchOption): BatchResponse[];
    delete(url: string, request?: Request): Response;
    do(request: Request): Response;
    file(data: string | ArrayBuffer, name?: string, contentType?: string): File;
    get(url: string, request?: Request): Response;
    head(url: string, request?: Request): Response;
    patch(url: string, body: string, request?: Request): Response;
    post(url: string, body: string | object | ArrayBuffer, request?: Request): Response;
    put(url: string, body: string, request?: Request): Response;
}

Type declaration

  • FormData: (new () => {
        append(key: string, value: string | File): void;
        body(): ArrayBuffer;
        contentType(): string;
    })

    构造 form-data 类型请求体。

    import http from 'pts/http';

    const data = open('./sample/tmp.js');

    export default function () {
        const formData = new http.FormData();
        formData.append('text', 'text');
        formData.append('file', http.file(data, 'tmp.js'));
        const resp = http.post('http://mockhttpbin.pts.svc.cluster.local/post', formData.body(), {
            headers: {'Content-Type': formData.contentType()}
        });
        console.log('formData: ', resp.body);
    };
      • new (): {
            append(key: string, value: string | File): void;
            body(): ArrayBuffer;
            contentType(): string;
        }

      • Returns {
            append(key: string, value: string | File): void;
            body(): ArrayBuffer;
            contentType(): string;
        }

        • append:function
          • append(key, value): void

          • Parameters

            • key: string

              键

            • value: string | File

              值

            Returns void

        • body:function
          • body(): ArrayBuffer

          • Returns ArrayBuffer

            请求体内容

        • contentType:function
          • contentType(): string

          • Returns string

            内容类型

  • batch:function
    • batch(requests, opt?): BatchResponse[]

    • 批量发起 http 请求。

      import http from 'pts/http';

      export default function () {
          let responses = http.batch([
              {
                  method: "GET",
                  url: "http://mockhttpbin.pts.svc.cluster.local/get?a=1",
                  headers: {a: "1, 2, 3"},
                  params: {b: 2}
              },
              {
                  method: "GET",
                  url: "http://mockhttpbin.pts.svc.cluster.local/get?a=1",
                  headers: {a: "1, 2, 3"},
                  params: {b: 2}
              }
          ])
          console.log(JSON.stringify(responses))
      };

      Parameters

      Returns BatchResponse[]

      响应对象数组

  • delete:function
    • delete(url, request?): Response

    • 发送 DELETE 请求。

      import http from 'pts/http';

      export default function () {
          const data = {user_id: '12345'};
          const resp = http.delete('http://mockhttpbin.pts.svc.cluster.local/delete', {query: data});
          console.log(resp.json().args.user_id); // 12345
      };

      Parameters

      • url: string

        URL

      • Optionalrequest: Request

        可选。请求对象

      Returns Response

      响应对象

  • do:function
    • do(request): Response

    • 发起 http 请求。

      import http from 'pts/http';

      export default function () {
          const req = {
              method: 'post',
              url: 'http://mockhttpbin.pts.svc.cluster.local/post',
              headers: {'Content-Type': 'application/json'},
              body: {user_id: '12345'}
          };
          const resp = http.do(req);
          console.log(resp.json().json.user_id); // 12345
      };

      Parameters

      Returns Response

      响应对象

  • file:function
    • file(data, name?, contentType?): File

    • 构造 FormData 上传文件对象。

      import http from 'pts/http';

      const data = open('./sample/tmp.js')

      export default function () {
          const file = http.file(data);
          console.log(file.data.length); // 231
          console.log(file.name); // 1635403323707745000
          console.log(file.contentType); // application/octet-stream
      };

      Parameters

      • data: string | ArrayBuffer

        文件内容

      • Optionalname: string

        文件名，默认为纳秒级时间戳

      • OptionalcontentType: string

        内容类型，默认为 application/octet-stream

      Returns File

      文件对象

  • get:function
    • get(url, request?): Response

    • 发送 GET 请求。

      import http from 'pts/http';

      export default function () {
          const data = {user_id: '12345'};
          const resp = http.get('http://mockhttpbin.pts.svc.cluster.local/get', {query: data});
          console.log(resp.json().args.user_id); // 12345
      };

      Parameters

      • url: string

        URL

      • Optionalrequest: Request

        可选。请求对象 Request

      Returns Response

      响应对象

  • head:function
    • head(url, request?): Response

    • 发送 HEAD 请求。

      import http from 'pts/http';

      export default function () {
          const data = {user_id: '12345'};
          const resp = http.head('http://mockhttpbin.pts.svc.cluster.local/head', {query: data});
          console.log(resp.statusCode); // 200
      };

      Parameters

      • url: string

        URL

      • Optionalrequest: Request

        可选。请求对象 Request

      Returns Response

      响应对象

  • patch:function
    • patch(url, body, request?): Response

    • 发送 PATCH 请求。

      import http from 'pts/http';

      export default function () {
          const data = {user_id: '12345'};
          const headers = {'Content-Type': 'application/json'};
          const resp = http.patch('http://mockhttpbin.pts.svc.cluster.local/patch', data, {headers: headers});
          console.log(resp.json().json.user_id); // 12345
      };

      Parameters

      • url: string

        URL

      • body: string

        请求体

      • Optionalrequest: Request

        可选。请求对象

      Returns Response

      响应对象

  • post:function
    • post(url, body, request?): Response

    • 发送 POST 请求。

      import http from 'pts/http';

      export default function () {
          const data = {user_id: '12345'};
          const headers = {'Content-Type': 'application/json'};
          const resp = http.post('http://mockhttpbin.pts.svc.cluster.local/post', data, {headers: headers});
          console.log(resp.json().json.user_id); // 12345
      };

      Parameters

      • url: string

        URL

      • body: string | object | ArrayBuffer

        请求体

      • Optionalrequest: Request

        可选。请求对象

      Returns Response

      响应对象

  • put:function
    • put(url, body, request?): Response

    • 发送 PUT 请求。

      import http from 'pts/http';

      export default function () {
          const data = {data: 'some data'};
          const headers = {'Content-Type': 'application/json'};
          const resp = http.put('http://mockhttpbin.pts.svc.cluster.local/put', data, {headers: headers});
          console.log(resp.json().json.data); // some data
      };

      Parameters

      • url: string

        URL

      • body: string

        请求体

      • Optionalrequest: Request

        可选。请求对象

      Returns Response

      响应对象

Settings

Member Visibility