Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bvalosek/http-transport
A basic isomorphic Javascript interface around HTTP requests
https://github.com/bvalosek/http-transport
Last synced: 10 days ago
JSON representation
A basic isomorphic Javascript interface around HTTP requests
- Host: GitHub
- URL: https://github.com/bvalosek/http-transport
- Owner: bvalosek
- Created: 2014-09-15T23:30:55.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2014-11-25T05:29:24.000Z (about 10 years ago)
- Last Synced: 2024-10-04T20:16:56.989Z (3 months ago)
- Language: JavaScript
- Size: 227 KB
- Stars: 5
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
Awesome Lists containing this project
README
# HttpTransport
[](https://travis-ci.org/bvalosek/http-transport)
[](http://badge.fury.io/js/http-transport)
A basic promise-driven Javascript interface for HTTP requests.
## Installation
```
$ npm install http-transport
```
## Rationale
* Directly accessing HTTP data sources in domain code leads to difficulty in
testing and is a violation of SRP.
* Complicated data abstraction layers are often too heavy-handed or not
flexible enough.
* Writing isomorphic code that uses HTTP requests can be difficult.
## Overview
This is a very small wrapper around the
[httpinvoke](https://github.com/jakutis/httpinvoke) module that compresses the
external API into the four primary HTTP verbs as methods that return a
`Promise`.
The `HttpTransport` class is meant to be instantiated once and shared
throughout the application when domain code needs access to the HTTP layer,
e.g. calling REST services.
Using a simple facade to make `GET` request vs e.g `$.get()` or the Node `http`
module allows for clean, testable, isomorphic code.
## Methods
```javascript
var HttpTransport = require('http-transport');
var transport = new HttpTransport();
```
### transport.get(url, params?): Promise
Execute a `GET` request with optional query parameters and return a `Promise` for
the response.
```javascript
// Basic GET
transport.get('/users')
.then(function(users) {
...
});
// With query params (fetches /users?group=admins)
transport.get('/users', { group: 'admins' })
.then(function(users) {
...
});
```
### transport.post(url, data?): Promise
Execute a `POST` request with optional object data passed as
`application/x-www-form-urlencoded` and return a `Promise` for the response.
```
transport.post('/blogs', { content: 'Hello, world!' })
.then(function(blog) {
...
});
```
### transport.put(url, data?): Promise
Execute a `PUT` request with optional object data passed as
`application/x-www-form-urlencoded` and return a `Promise` for the response.
```
transport.put('/users', { id: 123, name: 'Billy' })
.then(function(user) {
...
});
```
### transport.delete(url, params?): Promise
Execute a `DELETE` request with optional query parameters and return a `Promise` for
the response.
```javascript
transport.delete('/users', { id: 123 })
.then(function(resp) {
...
});
```
## JSONP
The `JsonpTransport` class also implements the `AbstractTransport` interface
and can be used the same as the `HttpTransport` class, except it will throw an
error if any method other than `GET` is used.
```javascript
var JsonpTransport = require('http-transport').JsonpTransport;
var transport = new JsonpTransport();
transport.get('http://api.external.com/').then(...);
```
## Testing
```
$ npm test
```
## License
MIT