Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cyberlight/service-status-page-rss-checker
https://github.com/cyberlight/service-status-page-rss-checker
Last synced: 20 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/cyberlight/service-status-page-rss-checker
- Owner: CyberLight
- License: mit
- Created: 2020-08-10T16:31:18.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-08-16T16:23:24.000Z (over 4 years ago)
- Last Synced: 2024-04-25T06:43:05.013Z (9 months ago)
- Language: JavaScript
- Size: 515 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# sspchecker (Service Status Page RSS Checker)
This library can check the status page of any service that supports the **Statuspage** like interface using RSS format (except Atom format).
## Installation
```bash
npm i -D @cyberlight/sspchecker
# or
npm i @cyberlight/sspchecker
```
## Usage
```JavaScript
const { getPageStatusesStream, withDefaultSubscription } = require('@cyberlight/sspchecker');
withDefaultSubscription(getPageStatusesStream([ 'https://status.service.name/path/to.rss', ... ]));
```
or from command line:
```bash
ssprsschecker-cli --urls https://status.npmjs.org/history.rss https://status.glitch.com/history.rss
```
or
```bash
ssprsschecker-cli --urls ./rssUrls.json
```
* where `./rssUrls.json` is a file with content like this:
```json
[
"https://status.npmjs.org/history.rss",
"https://status.gitlab.com/pages/5b36dc6502d06804c08349f7/rss",
"https://status.glitch.com/history.rss"
]
```
## Example of output
```bash
root@195e4786fcb0:/workspaces/service-status-page-rss-checker# sspchecker-cli --urls ./rssUrls.json
[i] Check service page statuses: [
'https://status.npmjs.org/history.rss',
'https://status.gitlab.com/pages/5b36dc6502d06804c08349f7/rss',
'https://status.glitch.com/history.rss'
]
No incidents found!
[i] status check completed
```
or
```bash
root@195e4786fcb0:/workspaces/service-status-page-rss-checker# sspchecker-cli --urls https://status.npmjs.org/history.rss https://status.glitch.com/history.rss
[i] Check service page statuses: [
'https://status.npmjs.org/history.rss',
'https://status.glitch.com/history.rss'
]
No incidents found!
[i] status check completed
```
## Running tests
```bash
npm test
```
## License
See the [LICENSE](LICENSE.md) file for license rights and limitations (MIT).