https://github.com/mkeen/rxhttp
👋 (Universal) Streaming Fetch HTTP Client Powered by ReactiveX (RxJS)
https://github.com/mkeen/rxhttp
http http-client javascript javascript-library npm-module rxjs rxjs6 typescript
Last synced: 9 months ago
JSON representation
👋 (Universal) Streaming Fetch HTTP Client Powered by ReactiveX (RxJS)
- Host: GitHub
- URL: https://github.com/mkeen/rxhttp
- Owner: mkeen
- License: isc
- Created: 2018-07-19T04:36:58.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T02:24:01.000Z (about 3 years ago)
- Last Synced: 2025-05-06T12:18:05.871Z (9 months ago)
- Topics: http, http-client, javascript, javascript-library, npm-module, rxjs, rxjs6, typescript
- Language: TypeScript
- Homepage:
- Size: 423 KB
- Stars: 8
- Watchers: 1
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 👋 RxHttp
HTTP Client that uses Fetch API built with TypeScript that supports real-time JSON streams. It runs in NodeJS and Browser. It's powered by RXJS.
### Why?
The Fetch API is the modern API for making http requests -- both long lived (streams) and traditional (simple). And RxJS makes it extremely convenient to build, chain, and consume asyncronous streams. These technologies all compliment each other well enough that it was worth creating this lib.
### Features
📀 **Universal** -- Works on both NodeJS and Browser
🌊 **Real-time** -- Supports long-lived real-time Chunked JSON streams
🆘 **Complete Observable Lifecycle** -- Simple request lifecycle uses `Observable` callback functions (`next`, `error`, and `complete`). Once the connection completes, or all subscribers have unsubbed, the connection will be cleaned up to ensure there aren't any memory leaks.
### Install
`npm install @mkeen/rxhttp`
https://www.npmjs.com/package/@mkeen/rxhttp
### Generate Docs
`npm run doc`
### The Most Bare Bones Example With Defaults
```typescript
import { HttpRequest } from '@mkeen/rxhttp';
new HttpRequest('https://localhost/simple')
.subscribe(
response => console.log('received response, connection closed', response);
);
// Output:
// received response, connection closed , {...}
```
### Simple (Request/Response) Request Example
```typescript
import { HttpRequest, FetchBehavior } from '@mkeen/rxhttp';
interface Person {
name: string;
email: string;
}
new HttpRequest(
'https://localhost/person',
{ method: 'POST', body: {
email: 'mwk@mikekeen.com',
name: 'Mike Keen'
} }
)
.fetch()
.subscribe(
response => console.log('person created successfully, connection closed', response)
);
// Output:
// person created successfully, connection closed, {...}
```
### Simple (Request/Response) Request With Error Handling Example
```typescript
import { HttpRequest, FetchBehavior } from '@mkeen/rxhttp';
interface Person {
name: string;
email: string;
}
new HttpRequest(
'https://localhost/person',
{ method: 'POST', body: {
email: 'mwk@mikekeen.com',
name: 'Mike Keen'
} },
FetchBehavior.simple
)
.fetch()
.subscribe(
(response: Person) => {
console.log('person created successfully, connection closed', response);
},
(error: any) => {
console.error('http error');
},
() => {
console.log('connection closed');
}
);
// Output:
// person created successfully, connection closed, {...}
```
###
### Streaming Request Example
```typescript
import { HttpRequest, FetchBehavior} from '@mkeen/rxhttp';
interface Person {
name: string;
email: string;
}
const personStream = new HttpRequest(
'https://localhost/person', {
method: 'GET'
}, FetchBehavior.stream
)
.fetch()
.subscribe(
(incoming_data: Person) => {
console.log('got person update: ', incoming_data);
},
(error: any) => {
console.error('http error');
},
() => {
console.log('connection closed');
}
);
// Output:
// got person update: , {id: 1 ...
// got person update: , {id: 2 ...
// got person update: , {id: 1 ...
// ...
```
### License
ISC (BSD 2 / MIT) - Enjoy
🇺🇸