1.8.11 • Published 9 months ago

typed-rest-client v1.8.11

Weekly downloads
187,844
License
MIT
Repository
github
Last release
9 months ago

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 6 and newer.

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.

holiday-checkerholiday-checker-testhomebridge-unifi-kids-crydhagberg-salesforce-sdknode-red-contrib-imsense-iot-platform@everything-registry/sub-chunk-2994vsce2homebridge-xiaoaiholiday-checkhomebridge-bloomskyhomebridge-mihomegatewayhomebridge-tabby-tshomebridge-unifi-mac-blockgui-wp-typescriptinclusivelintinclusivelint-libiizunajama-reporterjeeves-cliitem-level-downloadernode-arlonode-awms-choicesmite-api-tshowsmydrivingwa-seattlehowsmydriving-seattlemz-v3mailinator-clientmangaotaku-server-configuration-api-clientmangaotaku-user-api-clientepigon-clieb-checkin-modulegatsby-source-sylius-restfiredev-vscefetch-travis-datagdocs-databaseetiustoforex-quotesnpm-registry-apinode-red-contrib-imsense-iot-platform-x-1node-tp-link-powerlineproxyprobeplanethoster-apipipelines-appservice-libpipelines-appservice-lib-testpicpay-sdkpipedrive-clientrest-skidata-tdiserver-configuration-api-clientxiome@entan.gl/vsce@heroku/salesforce-sdk@fluffy-spoon/action@honeysucklehealth/tsalesforce@infinitebrahmanuniverse/nolb-typed@itunes-scraper-sdk/podcast-toolsvscevsce-cjsvsce-yarn-patchvsce3vso-node-apivsts-task-tool-libtyped-azure-clienttyped-azure-kudu@modelnest/cli@kimonocloud/cli@kimonocloud/kimono-core@inclusivelint/inclusivelint@mitter-io/corewechaty-intercomwechaty-plugin-intercomwendu-worker-testwasm-ociwebhookrelay-ws-clientweb3pay-sdk-jswdio5-mocha-testrail-reporterwindsdksupportvalisttfsrestservicetldrawligninvalue-auth-js@navadt/commonsocketxp-ws-clientstrykerscoresaber-api-clientscraperlibsetup-nuget-exesilverstripe-cms-dashboard@o.calvo/register-service@mpathirage/homebridge-gosundsw2-esphome@petbee/cielo-client@vine77/vsce@unfunco/ts-sportmonks@purelightpower/podio-ts@slashauth/node-client@rentready/azure-devops-node-api@spirale-tech/copycat-sdk@socialsflow/trigger-activitypub@starkmsu/azure-devops-node-api@stryker-mutator/core
1.8.10

9 months ago

1.8.11

9 months ago

1.8.9

2 years ago

1.8.6

3 years ago

1.8.5

3 years ago

1.8.4

3 years ago

1.8.3

3 years ago

1.8.1

3 years ago

1.8.0

3 years ago

1.7.3

4 years ago

1.7.2

4 years ago

1.7.1

4 years ago

1.7.0

4 years ago

1.5.0

5 years ago

1.4.0

5 years ago

1.2.0

5 years ago

1.1.2

5 years ago

1.0.11

5 years ago

1.0.9

6 years ago

1.0.7

6 years ago

1.0.6

6 years ago

1.0.5

6 years ago

1.0.4

6 years ago

1.0.3

6 years ago

1.0.2

6 years ago

1.0.1

6 years ago

1.0.0

6 years ago

0.15.1

6 years ago

0.14.2

6 years ago

0.14.1

6 years ago

0.14.0

6 years ago

0.8.0

6 years ago

0.13.0

6 years ago

0.12.0

7 years ago

0.11.0

7 years ago

0.10.0

7 years ago

0.9.0

7 years ago

0.7.0

7 years ago