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)

• Basic, Bearer and NTLM Support out of the box
• Proxy support
• Certificate support (Self-signed server and client cert)
• Layered for Rest or Http use
• Full Samples and Tests included for usage

Installing

This client requires typings in order to work correctly. Firstly, ensure that you have typings installed by installing the typings module globally via the command line:

npm i -g typings

Once typings is installed, create a typings.json file in the root of your project:

{
  "dependencies": {},
  "globalDependencies": {
    "node": "registry:dt/node#6.0.0+20160720070758",
    "q": "registry:dt/q#0.0.0+20160613154756"
  }
}

Then, in the console, run typings to create the typings files: typings install

Ensure that your tsconfig.json has the requisite compilerOptions to ensure that typed-rest-client is found:

{
    "compilerOptions": {
        "target": "ES6",
        "module": "commonjs",
        "moduleResolution": "node"
    },
    "files": [
        "my_file.ts"
    ]
}

Finally, install the typed-rest-client using the npm console command:

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.