Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jscutlery/convoyr
Modular HTTP extensions for Angular.
https://github.com/jscutlery/convoyr
angular rxjs typescript
Last synced: 23 days ago
JSON representation
Modular HTTP extensions for Angular.
- Host: GitHub
- URL: https://github.com/jscutlery/convoyr
- Owner: jscutlery
- License: mit
- Created: 2019-10-02T17:36:06.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-26T01:08:45.000Z (8 months ago)
- Last Synced: 2024-05-01T19:52:55.505Z (8 months ago)
- Topics: angular, rxjs, typescript
- Language: TypeScript
- Homepage:
- Size: 9.9 MB
- Stars: 41
- Watchers: 2
- Forks: 3
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-angular - convoyr - Modular HTTP extensions for Angular. (Table of contents / Angular)
- fucking-awesome-angular - convoyr - Modular HTTP extensions for Angular. (Table of contents / Angular)
- fucking-awesome-angular - convoyr - Modular HTTP extensions for Angular. (Table of contents / Angular)
README
Modular HTTP extensions for Angular.
# Motivation
Enriching HTTP clients with capabilities related to **security**, **performance** or **resilience** is a common need but it is also an error-prone and sometimes complex task.
**Convoyr** has been built with one goal in mind: helping you focus on your apps' features instead of the transport layer's boilerplate and matters... and without any trade-off.
- 🅰️ **Convoyr** is **Angular-ready** and makes [interceptors](https://angular.io/api/common/http/HttpInterceptor) implementation safe and easy,
- ⚡️ **Convoyr** is **fully reactive** and based on [RxJS](https://rxjs-dev.firebaseapp.com/),
- 🔋 **Convoyr** has **batteries included** as it comes with some useful plugins,
- 📈 **Convoyr** is **progressive** because you can start using it without having to rewrite all your HTTP calls,
- 🧱 **Convoyr** is **easily extendable** as you can create and share your own plugins.
# Quick Start
1. Install core packages inside your project.
```bash
yarn add @convoyr/core @convoyr/angular # or npm install @convoyr/core @convoyr/angular
```
2. Install plugins packages.
```bash
yarn add @convoyr/plugin-cache @convoyr/plugin-retry # or npm install @convoyr/plugin-cache @convoyr/plugin-retry
```
3. Import the module and define plugins you want to use.
```ts
import { ConvoyrModule } from '@convoyr/angular';
import { createCachePlugin } from '@convoyr/plugin-cache';
import { createRetryPlugin } from '@convoyr/plugin-retry';
@NgModule({
imports: [
ConvoyrModule.forRoot({
plugins: [
createCachePlugin(), // enable caching of all GET requests (Cf. @convoyr/plugin-cache)
createRetryPlugin(), // automatically retry failed requests (Cf. @convoyr/plugin-retry)
],
}),
]
})
export class AppModule {}
```
4. Check out [built-in plugins documentation](https://github.com/jscutlery/convoyr#built-in-plugins) and learn how to configure them.
# How It Works
The main building block is the plugin. A plugin is a simple object that lets you intercept network communications and control or transform them easily. Like an [`HttpInterceptor`](https://angular.io/api/common/http/HttpInterceptor) a plugin may transform outgoing request and the response stream as well before passing it to the next plugin.
Convoyr comes with its built-in plugin collection to provide useful features to your apps and to tackle the need to rewrite redundant logic between projects.
# Built-in Plugins
This project is a monorepo that includes the following packages.
| Package | Name | Description |
| -------------------------------------------- | ------------ | ----------------------------------------------------------------- |
| [@convoyr/plugin-auth](./libs/plugin-auth) | Auth plugin | Handle authentication |
| [@convoyr/plugin-cache](./libs/plugin-cache) | Cache plugin | Respond with cached results first then with fresh data when ready |
| [@convoyr/plugin-retry](./libs/plugin-retry) | Retry plugin | Retry failed requests with exponential backoff |
# Custom Plugins
Follow the guide to [create your own custom plugins](./docs/custom-plugin.md).
# Resources
Here is a list of useful resources related to Convoyr.
- 📝 [Introducing Convoyr, the reactive HTTP extensions for Angular](https://www.codamit.dev/introducing-convoyr)
- 📝 [Plugin Testing in Convoyr](https://www.codamit.dev/plugin-testing-in-convoyr)
- 📝 [Spice Up your Caching with Convoyr](https://medium.com/marmicode/spice-up-your-caching-with-convoyr-d79347809110)
# Roadmap
For incoming evolutions [see our board](https://github.com/jscutlery/convoyr/projects/1).
# Changelog
For new features or breaking changes [see the changelog](CHANGELOG.md).
# Contributing
See our [contributing guide](./CONTRIBUTING.md) before starting. Contributions of any kind welcome!
# Contributors
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.
Younes Jaaidi
🐛 💻 📖 💡 🤔
Edouard Bozon
🐛 💻 📖 💡 🤔
Pierre-Edouard Galtier
📖
# License
This project is MIT licensed.