adk23333/github-pages-deploy-action
1
0
Fork 0
mirror of https://github.com/JamesIves/github-pages-deploy-action.git synced 2023-12-15 20:03:39 +08:00
Code Issues Packages Projects Releases Wiki Activity
b52d6c9afc
github-pages-deploy-action/node_modules/@actions/http-client
History
JamesIves db6073b9d5 Dependencies Required
2020-01-28 00:07:56 -05:00
..
actions.png Dependencies Required 2020-01-28 00:07:56 -05:00
auth.d.ts Dependencies Required 2020-01-28 00:07:56 -05:00
auth.js Dependencies Required 2020-01-28 00:07:56 -05:00
index.d.ts Dependencies Required 2020-01-28 00:07:56 -05:00
index.js Dependencies Required 2020-01-28 00:07:56 -05:00
interfaces.d.ts Dependencies Required 2020-01-28 00:07:56 -05:00
interfaces.js Dependencies Required 2020-01-28 00:07:56 -05:00
LICENSE Dependencies Required 2020-01-28 00:07:56 -05:00
package.json Dependencies Required 2020-01-28 00:07:56 -05:00
proxy.d.ts Dependencies Required 2020-01-28 00:07:56 -05:00
proxy.js Dependencies Required 2020-01-28 00:07:56 -05:00
README.md Dependencies Required 2020-01-28 00:07:56 -05:00

README.md

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

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. We also support the latest LTS for Node 6, 8 and Node 10.

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