https://github.com/recuencojones/httpr-provider-node-request

Provider for node requests with request module in httpr.
https://github.com/recuencojones/httpr-provider-node-request

http httpr httpr-provider node request typescript

Last synced: 12 days ago
JSON representation

Provider for node requests with request module in httpr.

• Host: GitHub
• URL: https://github.com/recuencojones/httpr-provider-node-request
• Owner: RecuencoJones
• License: mit
• Created: 2017-03-11T13:45:04.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-03-11T14:34:22.000Z (almost 8 years ago)
• Last Synced: 2024-12-07T22:25:48.778Z (about 1 month ago)
• Topics: http, httpr, httpr-provider, node, request, typescript
• Language: TypeScript
• Size: 5.86 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![npm package](https://badge.fury.io/js/httpr-provider-node-request.svg)](https://badge.fury.io/js/httpr-provider-node-request)

[![Build Status](https://travis-ci.org/RecuencoJones/httpr-provider-node-request.png?branch=develop)](https://travis-ci.org/RecuencoJones/httpr-provider-node-request)

# httpr-provider-node-request

Httpr provider implementation for node requests with [request](https://npmjs.com/package/request).

## Import

The library requires a peer of Httpr and request.

### ES6 import

```

import {Httpr} from 'httpr';

import {NodeRequestProvider} from 'httpr-provider-node-request';

const http = new Httpr({

  provider: new NodeRequestProvider()

});

```

### Commonjs

```

const Httpr = require('httpr').Httpr;

const NodeRequestProvider = require('httpr-provider-node-request').NodeRequestProvider;

const http = new Httpr({

  provider: new NodeRequestProvider()

});

```

## Type Definitions

For TypeScript usage, a file with type definitions is bundled in npm.

This file is generated using [barrel-defgen](https://github.com/RecuencoJones/barrel-defgen).

## Building

```

npm install

npm run build

```

These commands will setup the package and generate the distributable files as well as the type definitions.

Other tasks:

- `npm run build:umd` - generate library bundle.

- `npm run build:min` - generate minified library bundle.

- `npm run build:defs` - generate definitions from barrel to `defs` directory.

- `npm run clean` - remove generated directories.

- `npm run lint` - check style of source files.

- `npm run doc` - generate documentation from sources to `doc` directory.

- `npm run test` - run all test suites.

- `npm run test:unit` - run unit tests only.