@convoyr/plugin-cache
npm i @convoyr/plugin-cache

@convoyr/plugin-cache

Modular HTTP extensions for Angular.

by jscutlery

4.0.0 (see all)License:MITTypeScript:Not Found
npm i @convoyr/plugin-cache
Readme

convoyr logo

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

  1. Install core packages inside your project.
yarn add @convoyr/core @convoyr/angular # or npm install @convoyr/core @convoyr/angular
  1. Install plugins packages.
yarn add @convoyr/plugin-cache @convoyr/plugin-retry # or npm install @convoyr/plugin-cache @convoyr/plugin-retry
  1. 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 {}
  1. 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.

PackageNameDescription
@convoyr/plugin-authAuth pluginHandle authentication
@convoyr/plugin-cacheCache pluginRespond with cached results first then with fresh data when ready
@convoyr/plugin-retryRetry pluginRetry failed requests with exponential backoff

Custom Plugins

Follow the guide to create your own custom plugins.

Resources

Here is a list of useful resources related to Convoyr.

Roadmap

For incoming evolutions see our board.

Changelog

For new features or breaking changes see the changelog.

Contributing

See our contributing guide before starting. Contributions of any kind welcome!

Contributors

This project follows the all-contributors specification.


Younes Jaaidi

🐛 💻 📖 💡 🤔

Edouard Bozon

🐛 💻 📖 💡 🤔

Pierre-Edouard Galtier

📖

License

This project is MIT licensed.

Downloads/wk

1

GitHub Stars

36

LAST COMMIT

6mos ago

MAINTAINERS

2

CONTRIBUTORS

3

OPEN ISSUES

11

OPEN PRs

22
VersionTagPublished
4.0.0
latest
2yrs ago
No alternatives found
No tutorials found
Add a tutorial