Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cancerberosgx/plugin-container
Plugin-container is a design pattern similar to Observer, but with ore emphasis on data processing, state change, and cancelable actions. Very useful and simple pattern to add extension points to your APIs or frameworks.
https://github.com/cancerberosgx/plugin-container
Last synced: about 2 months ago
JSON representation
Plugin-container is a design pattern similar to Observer, but with ore emphasis on data processing, state change, and cancelable actions. Very useful and simple pattern to add extension points to your APIs or frameworks.
- Host: GitHub
- URL: https://github.com/cancerberosgx/plugin-container
- Owner: cancerberoSgx
- License: mit
- Created: 2018-04-22T19:41:52.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-04-25T16:33:02.000Z (over 6 years ago)
- Last Synced: 2024-09-20T00:49:44.670Z (4 months ago)
- Language: TypeScript
- Size: 151 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/cancerberoSgx/plugin-container) [](https://ci.appveyor.com/project/cancerberoSgx/plugin-container/branch/master) [](https://codecov.io/gh/cancerberoSgx/plugin-container/tree/master/src) [](https://david-dm.org/cancerberosgx/plugin-container) [](https://david-dm.org/cancerberosgx/plugin-container-dev#info=devDependencies)
# Plugin Container
Plugin-container is a design pattern similar to Observer, but with ore emphasis on data processing, state change, and cancelable actions.
Powerful and simple pattern to add extension points to your APIs or frameworks.
# API Reference
https://cancerberosgx.github.io/plugin-container/interfaces/iplugincontainer.html
# Install
```sh
npm install --save plugin-container
```
# Usage
```js
import { PluginContainer } from 'plugin-container';
const plugins = new PluginContainer();
plugins.install({
name: 'secondPlugin',
priority: 2,
execute(input) {
return `avacadabra${input}flumflumblablasrpic`;
},
});
plugins.install({
name: 'first plugin',
priority: 1,
execute(input) {
return input.replace(/blabla/gi, 'loremipsum');
},
});
const output = plugins.executeAll('hello world blabla world');
console.log(output)
// the output is the transformation, in other, of all the plugins, in this case:
// 'avacadabrahello world loremipsum worldflumflumloremipsumsrpic'
```
# Use it in the browser
plugin-container supports very old browsers. Just use files in `build/es3`, for example, after loading plugin-container-globals.js the global variable `PluginContainer` will be available:
```html
var plugins = new PluginContainer();
....
```
Or you can use the AMD version if you want:
```html
<script src="https://cdn.jsdelivr.net/npm/[email protected]/almond.min.js">
var PluginContainer = require('PluginContainer')
var plugins = new PluginContainer();
....
```
# Ideas / TODOs
## Errors
if a plugin.execute throws an exception - what the container should do ?
## asynchronous plugins
* executeAll is sync and plugins.execute() must be sync
Proposal:
// install an asynchronous plugin. If execute returns a promise / thenable - then the ocntainer will wait for it to resolve / reject before executing the next plugins
plugins.install({
name: 'my-async-plugin,
priority: 1
execute: (input){
return new Promise(resolve=>{
return request('third/party/service').then(error=>{
if(error){
input.thirdPartyValidationError = error
reject(error)
}
else{
input.thirdPartyValidationOk=!error;
resolve(input) // so next plugins can keep processing the input
}
})
})
}
})
// install a synchronous plugin - it wil lbe executed after the first one is resolved or rejected
plugins.install(
name: 'my-async-plugin,
priority: 2
execute: function(input){
if(input.thirdPartyValidationOk){
doSomethingWith(input)
}
return input
}
)
Questions: What is the semantics of a rejected promise ? What the container should do ? probably rejected promises have same semantics that throws.
## Cancelling
* use case: I want my users to be able to subscribe plugins before something happens and