https://github.com/7c/coadmin-lib
coadmin-lib
https://github.com/7c/coadmin-lib
Last synced: 4 months ago
JSON representation
coadmin-lib
- Host: GitHub
- URL: https://github.com/7c/coadmin-lib
- Owner: 7c
- Created: 2021-12-03T16:22:00.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-11T16:05:16.000Z (5 months ago)
- Last Synced: 2025-02-11T17:24:51.664Z (5 months ago)
- Language: JavaScript
- Size: 43 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Coadmin Project Libraries
## CoadminService Class
```
const { CoadminService } = require('coadmin-lib')
const coadmin_service = new CoadminService('ServiceName')
coadmin_service.report('started')
while(true) {
coadmin_service.report_every(1,'loop',false,true)
}
coadmin_service.report('finished')
coadmin_service.report_error('exception')
```
## CoadminService3 Class
```
import { CoadminService3 } from 'coadmin-lib'
const coadmin_service = new CoadminService3('ServiceName')
coadmin_service.report('started')
```
## typescript
```
import { ReportIssues } from 'coadmin-lib'
// live mode
const riLive = new ReportIssues('demoLive',{
live: true,
server: 'http://127.0.0.1:9091/api',
server_path: '/socket2.io',
output: true
})
riLive.warning('test warning')
// passive mode
const riPassive = new ReportIssues('demoPassive',{live: false, folder: '/var/coadmin'})
riPassive.warning('test warning')
```
## ReportIssues Class
use description to describe the issue but without using too many variables inside the description, you can put extra parameters as json, third parameter is for options: 'expireAfter' (in minutes)
```
const ReportIssues = new (require('coadmin-lib').ReportIssues)('AppName')
``
ReportIssues.info('info level description',{extra:'extra info'})
ReportIssues.warning('warn level description',{extra:'extra info'},{ expireAfter:10 })
ReportIssues.fatal('fatal level description',{extra:'extra info'})
ReportIssues.error('error level description',{extra:'extra info'})
```
### NetworkingTests Class
### Mysql2Tests Class
### Mysql1Tests Class