Skip to content

Commit

Permalink
docs: add jsdoc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
venki91 committed Jul 13, 2024
1 parent 6b58b0a commit 109b117
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions lib/index.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,44 @@
/**
* @typedef {Object} Log
* @property {number} [id]
* @property {string} hostname
* @property {number} pid
* @property {string} source
* @property {Date} timestamp
* @property {string} level
* @property {string} message
* @property {string} [meta]
*/

/**
* @typedef {Object} LogFilter
* @property {string} [hostname]
* @property {number} [pid]
* @property {{source: string, level: string}[]} [level_json]
* @property {string[]} [sources]
* @property {string[]} [levels]
* @property {number} [lt_id]
* @property {number} [gt_id]
* @property {Date} [lte_timestamp]
* @property {Date} [gte_timestamp]
* @property {number} [limit=100]
*/

/**
* @typedef {Object} Config
* @property {number} id
* @property {string} key
* @property {string} value
*/

/**
* @typedef {Object} User
* @property {number} id
* @property {string} name
* @property {string} email
* @property {string} role
*/

const bcrypt = require('bcryptjs');
const { EventEmitter } = require('events');
const cron = require('node-cron');
Expand Down

0 comments on commit 109b117

Please sign in to comment.