Package Exports

typed-rest-client
typed-rest-client/HttpClient
typed-rest-client/RestClient
typed-rest-client/Util

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (typed-rest-client) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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 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 opencode@microsoft.com with any additional questions or comments.