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 implementation safe and easy,
⚡️ Convoyr is fully reactive and based on RxJS,
🔋 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

Install core packages inside your project.

yarn add @convoyr/core @convoyr/angular # or npm install @convoyr/core @convoyr/angular

Install plugins packages.

yarn add @convoyr/plugin-cache @convoyr/plugin-retry # or npm install @convoyr/plugin-cache @convoyr/plugin-retry

Import the module and define plugins you want to use.

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 {}

Check out built-in plugins documentation 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 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	Auth plugin	Handle authentication
@convoyr/plugin-cache	Cache plugin	Respond with cached results first then with fresh data when ready
@convoyr/plugin-retry	Retry plugin	Retry failed requests with exponential backoff