github.com/jfrog/frogbot@v1.1.1-0.20231221090046-821a26f50338/action/node_modules/@actions/http-client/README.md (about)

     1  # `@actions/http-client`
     2  
     3  A lightweight HTTP client optimized for building actions.
     4  
     5  ## Features
     6  
     7    - HTTP client with TypeScript generics and async/await/Promises
     8    - Typings included!
     9    - [Proxy support](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/about-self-hosted-runners#using-a-proxy-server-with-self-hosted-runners) just works with actions and the runner
    10    - Targets ES2019 (runner runs actions with node 12+).  Only supported on node 12+.
    11    - Basic, Bearer and PAT Support out of the box.  Extensible handlers for others.
    12    - Redirects supported
    13  
    14  Features and releases [here](./RELEASES.md)
    15  
    16  ## Install
    17  
    18  ```
    19  npm install @actions/http-client --save
    20  ```
    21  
    22  ## Samples
    23  
    24  See the [tests](./__tests__) for detailed examples.
    25  
    26  ## Errors
    27  
    28  ### HTTP
    29  
    30  The HTTP client does not throw unless truly exceptional.
    31  
    32  * A request that successfully executes resulting in a 404, 500 etc... will return a response object with a status code and a body.
    33  * Redirects (3xx) will be followed by default.
    34  
    35  See the [tests](./__tests__) for detailed examples.
    36  
    37  ## Debugging
    38  
    39  To enable detailed console logging of all HTTP requests and responses, set the NODE_DEBUG environment varible:
    40  
    41  ```shell
    42  export NODE_DEBUG=http
    43  ```
    44  
    45  ## Node support
    46  
    47  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+.
    48  
    49  ## Support and Versioning
    50  
    51  We follow semver and will hold compatibility between major versions and increment the minor version with new features and capabilities (while holding compat).
    52  
    53  ## Contributing
    54  
    55  We welcome PRs.  Please create an issue and if applicable, a design before proceeding with code.
    56  
    57  once:
    58  
    59  ```
    60  npm install
    61  ```
    62  
    63  To build:
    64  
    65  ```
    66  npm run build
    67  ```
    68  
    69  To run all tests:
    70  
    71  ```
    72  npm test
    73  ```