@actions/http-client 中文文档教程

发布于 4年前 浏览 9 项目主页 更新于 3年前

Actions Http-Client

Http Status

一个轻量级 HTTP 客户端,优化用于操作、带有泛型的 TypeScript 和异步等待。

Features

  • HTTP client with TypeScript generics and async/await/Promises
  • Typings included so no need to acquire separately (great for intellisense and no versioning drift)
  • Proxy support just works with actions and the runner
  • Targets ES2019 (runner runs actions with node 12+). Only supported on node 12+.
  • Basic, Bearer and PAT Support out of the box. Extensible handlers for others.
  • Redirects supported

功能和版本此处

Install

npm install @actions/http-client --save

Samples

请参阅HTTP 测试以获取详细示例。

Errors

HTTP

除非真正异常,否则 HTTP 客户端不会抛出异常。

  • A request that successfully executes resulting in a 404, 500 etc… will return a response object with a status code and a body.
  • Redirects (3xx) will be followed by default.

有关详细示例,请参阅 HTTP 测试

Debugging

要启用所有 HTTP 请求和响应的详细控制台日志记录,请设置 NODE_DEBUG 环境变量:

export NODE_DEBUG=http

Node support

http 客户端是使用 Node 12 的最新 LTS 版本构建的。它可能适用于以前的节点 LTS 版本,但它已经过测试并在 Node12+ 上得到官方支持。

Support and Versioning

我们遵循 semver 并将保持主要版本之间的兼容性,并增加具有新特性和功能的次要版本(同时保持兼容性)。

Contributing

我们欢迎 PR。 请在继续编写代码之前创建一个问题,如果适用,请创建一个设计。

一次:

$ npm install

构建:

$ npm run build

运行所有测试:

$ npm test

Actions Http-Client

Http Status

A lightweight HTTP client optimized for use with actions, TypeScript with generics and async await.

Features

  • HTTP client with TypeScript generics and async/await/Promises
  • Typings included so no need to acquire separately (great for intellisense and no versioning drift)
  • Proxy support just works with actions and the runner
  • Targets ES2019 (runner runs actions with node 12+). Only supported on node 12+.
  • Basic, Bearer and PAT Support out of the box. Extensible handlers for others.
  • Redirects supported

Features and releases here

Install

npm install @actions/http-client --save

Samples

See the HTTP tests for detailed examples.

Errors

HTTP

The HTTP client does not throw unless truly exceptional.

  • A request that successfully executes resulting in a 404, 500 etc… will return a response object with a status code and a body.
  • Redirects (3xx) will be followed by default.

See HTTP tests for detailed examples.

Debugging

To enable detailed console logging of all HTTP requests and responses, set the NODE_DEBUG environment varible:

export NODE_DEBUG=http

Node support

The http-client is built using the latest LTS version of Node 12. It may work on previous node LTS versions but it's tested and officially supported on Node12+.

Support and Versioning

We follow semver and will hold compatibility between major versions and increment the minor version with new features and capabilities (while holding compat).

Contributing

We welcome PRs. Please create an issue and if applicable, a design before proceeding with code.

once:

$ npm install

To build:

$ npm run build

To run all tests:

$ npm test
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文