microsoft
/
typed-rest-client
зеркало из https://github.com/microsoft/typed-rest-client.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность
Node Rest and Http Clients with typings for use with TypeScript
185 коммитов 40 Ветки 11 Теги 3,6 MiB
TypeScript 85.4%
JavaScript 14.6%
Перейти к файлу
Marcin Strzyz 06d0fc1eae
Added handling for when we have network failures in the retry mechanism (#223) 
* Added handling for when we have network failures in the retry mechanism

* forgot ";'

* Fixed to be proper version

* .
 		2020-06-30 16:05:39 -04:00
.github/workflows Add stale workflow (#209) 2020-04-02 11:35:31 -04:00
docs Update README, including adding debug steps (#130) 2019-02-26 13:43:55 -05:00
lib Added handling for when we have network failures in the retry mechanism (#223) 2020-06-30 16:05:39 -04:00
samples Fix security warnings (#210) 2020-05-07 10:14:05 -04:00
test Support adding query params for DELETE. (#214) 2020-05-11 13:03:02 -04:00
.gitignore Adding back change from pr 2018-11-07 16:32:44 -05:00
CONTRIBUTING.md Add node/npm recommendation in contributing.md 2019-05-08 10:21:24 -04:00
LICENSE Write nock tests for all handlers and change codebase for NTLM handler (#194) 2020-01-10 11:29:35 -05:00
README.md note about security issues 2019-10-24 09:00:54 -04:00
ThirdPartyNotice.txt Add ThirdPartyNotice and copy that and package lock to _build. (#64) 2018-03-23 13:58:56 -04:00
azure-pipelines.yml Update azure-pipelines.yml 2019-03-08 12:49:52 -05:00
generate-third-party-notice.js Add ThirdPartyNotice and copy that and package lock to _build. (#64) 2018-03-23 13:58:56 -04:00
issue_template.md Users/stfrance/issue template (#37) 2017-12-07 08:21:34 -05:00
make.js Add headers to rest response (#105) 2019-04-09 08:22:21 -04:00
package-lock.json Added handling for when we have network failures in the retry mechanism (#223) 2020-06-30 16:05:39 -04:00
package.json Added handling for when we have network failures in the retry mechanism (#223) 2020-06-30 16:05:39 -04:00
tsconfig.json refactor(casing): Force consistent casing (#25) 2017-11-30 17:55:52 -05:00

README.md

GitHub Actions status

Build Status

Typed REST and HTTP Client with TypeScript Typings

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

Features

  • REST and HTTP client with TypeScript generics and async/await/Promises
  • Typings included so no need to acquire separately (great for intellisense and no versioning drift)
  • Basic, Bearer and NTLM Support out of the box. Extensible handlers for others.
  • Proxy support
  • Certificate support (Self-signed server and client cert)
  • Redirects supported

Intellisense and compile support:

intellisense

Install

npm install typed-rest-client --save

Or to install the latest preview:

npm install typed-rest-client@preview --save

Samples

See the samples for complete coding examples. Also see the REST and 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.

REST

The REST client is a high-level client which uses the HTTP client. Its responsibility is to turn a body into a typed resource object.

  • A 200 will be success.
  • Redirects (3xx) will be followed.
  • A 404 will not throw but the result object will be null and the result statusCode will be set.
  • Other 4xx and 5xx errors will throw. The status code will be attached to the error object. If a RESTful error object is returned ({ message: xxx}), then the error message will be that. Otherwise, it will be a generic, Failed Request: (xxx).

See REST 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

or

set NODE_DEBUG=http

Node support

The typed-rest-client is built using the latest LTS version of Node 8. We also support the latest LTS for Node 4 and Node 6.

Contributing

To contribute to this repository, see the contribution guide

To build:

$ npm run build

To run all tests:

$ npm test

To just run unit tests:

$ npm run units

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Security Issues

Do you think there might be a security issue? Have you been phished or identified a security vulnerability? Please don't report it here - let us know by sending an email to secure@microsoft.com.