actions/http-client
1
0
Fork 0
mirror of https://github.com/actions/http-client.git synced 2025-02-24 16:22:28 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
A lightweight HTTP client optimized for use with actions, TypeScript with generics and async await.
57 Commits 17 Branches 0 Tags 369 KiB
TypeScript 99.6%
JavaScript 0.4%
update-default-branch
Go to file
Andy McKay 647e77eb60
Rename to work with main 
Updates the Action to listen to main #28. I didn't spot much else in here that we need to do yet.
2020-07-21 08:46:10 -07:00
__tests__ Merge pull request #25 from JamieMagee/deprecated-url 2020-04-30 11:34:56 -04:00
.github/workflows Rename to work with main 2020-07-21 08:46:10 -07:00
.gitignore initial commit 2020-01-09 18:32:59 -05:00
.prettierignore prettier files 2020-04-10 09:21:58 -04:00
.prettierrc.json prettier files 2020-04-10 09:21:58 -04:00
actions.png readme 2020-01-09 23:08:26 -05:00
auth.ts apply formatting 2020-04-10 09:50:06 -04:00
index.ts Merge pull request #25 from JamieMagee/deprecated-url 2020-04-30 11:34:56 -04:00
interfaces.ts Remove deprecated URL API usage 2020-04-11 17:04:55 +02:00
jest.config.js initial commit 2020-01-09 18:32:59 -05:00
LICENSE code review 2020-01-10 18:12:28 -05:00
package-lock.json apply formatting 2020-04-10 09:50:06 -04:00
package.json it's pretty now and bump version 2020-04-23 16:33:34 -04:00
proxy.ts Remove deprecated URL API usage 2020-04-11 17:04:55 +02:00
README.md update readme 2020-02-04 08:24:40 -05:00
RELEASES.md Update RELEASES.md 2020-04-29 21:06:11 -04:00
tsconfig.json Revert unnecessary changes 2020-01-11 21:23:55 -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

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