amaury.joly/listener-rss-agregators-tests
1
0
Fork 0
forked from Outils-PeerTube/listener-rss-aggregator
Code Issues Pull Requests Projects Releases Wiki Activity

release 0.0.4

Browse Source
This commit is contained in:
Amaury
2021-07-24 18:24:52 +02:00
parent fcdd468a4d
commit 7ba511056b
12 changed files with 29 additions and 692 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -1,19 +1,20 @@
# Listener-rss-agregator
# Listener-rss-aggregator
---
## Brief
This is an agregator of rss's listener (more information about it here : ).
This is an aggregator of rss's listener (more information about it here : https://www.npmjs.com/package/listener-rss).
## Usage
The basic usage is to use many listener-rss with a unique class.
```typescript
import { ManageListener } from 'Listener-rss-agregator';
import { ListenerRssAggregator } from 'Listener-rss-aggregator';
const path = '/my/data/directorie/bd.sqlite'
const myManager = new ManageListener(path);
const path = '/my/data/directorie/bd.sqlite'
const configAggregator = await ListenerRssAggregator.instantiateAggregator(
path
);
myManager = new ListenerRssAggregator(configAggregator);
await ml.load(); // he is reading the database
const listenerConfig =
const listenerConfig: ListenerRss.Config =
{
"address": "fake.rss.service.1",
"timeloop": 10
@ -23,7 +24,6 @@ ml.registerListener(listenerConfig);
ml.on('update', (obj) => {
doSomethingWithNewEntries(obj);
ml.save();
})
ml.startAll();
@ -31,7 +31,6 @@ ml.startAll();
//...
ml.stopAll();
ml.save();
```
## Documentation
### Why SQLITE
@ -39,16 +38,24 @@ This project use SQLITE to store the listener-rss configs and keep an correct hi
### Constructor
The constructor need to have a file to store the sqlite data. If the file does not exist he will be create, but the path must be valid.
### Function
#### `load()`
An async method who would read the sqlite file and create the corresponding objects
#### `save()`
An method who would store the actual configuration and erase the older
#### `registerListener(listenerConfig)`
He's create an new listener-rss with the corresponding config data. (More information about the listenerConfig here : )
He's create an new listener-rss with the corresponding config data. (More information about the listenerConfig here : https://www.npmjs.com/package/listener-rss)
#### `startAll()`
Start all the listener who are actually register
#### `stopAll()`
Start all the listener who are actually register
#### `editConfig(callback)`
This method will call the callback with the actual config of the Manager and override the actual config with the returned object.
e.g.:
```typescript
myManager.editConfig((actualConfig: ListenerRss.Config[]) : ListenerRss.Config[] => {
const modifiedConfig = doSomethingToThisConfig(actualConfig);
return modifiedConfig;
})
```
### Events
Like listener-rss, listener-rss-agregator implement EventEmitter.
The event who's used is named `update`. He's called for each new entries detection per listener. he's giving back an object who contains all the new entries
Like listener-rss, listener-rss-aggregator implement EventEmitter.
He call the same events than listener-rss. One call is made for each listener who triggered an event.
The `update` event return all the rss file content in one json object.
The `newEntries` event return an object with a file `items` who's contains the new items detected. And a field called `addressListener` who's a string with the address of the the rss service.