Skip to content

Latest commit

 

History

History
80 lines (50 loc) · 2.1 KB

README.md

File metadata and controls

80 lines (50 loc) · 2.1 KB

Typed Rest and Http Client with TypeScript Typings

A lightweight Rest and Http Client optimized for use with TypeScript with generics and async await.

Status

With 0.9 just published, we believe the API surface for 1.0 has settled. More testing in progress then we will release 1.0.

Features

  • Rest Client with typescript generics and async/await/Promises
  • Http Client with pipe stream support and async/await/Promises
import * as rm from 'typed-rest-client/RestClient';

let restc: rm.RestClient = new rm.RestClient('rest-samples', 
                                             'https://mystudentapiserver');

let res: rm.IRestResponse<Student> = await restc.get<Student>('/students/5');

console.log(res.statusCode);
console.log(res.result.name);
  • Typings included so no need to acquire separately (great for intellisense and no versioning drift)

intellisense

  • Basic, Bearer and NTLM Support out of the box
  • Proxy support
  • Layered for Rest or Http use
  • Full Samples and Tests included for usage

Install the library

npm install typed-rest-client --save

Samples

See samples for complete coding examples

Typings

Typings (.d.ts) are distributed with the client, so intellisense and compile support just works from tsc and vscode

Pre-Requisites

Pre-req: prefer Node 6.9.3 LTS, minimum Node >= 4.4.7 LTS Typings: npm install typings -g

Once (or when dependencies change):

npm install
typings install

Build

npm run build

Running Samples

Run samples:

$ npm run samples

Contributing

To contribute to this repository, see the contribution guide

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 [email protected] with any additional questions or comments.