chore(xo-server-audit): document audit DB strucure (#5078)

2020-07-07 15:22:41 +02:00 · 2020-07-07 15:22:41 +02:00 · 4db181d8bf
commit 4db181d8bf
parent 9a7a1cc752
1 changed files with 16 additions and 0 deletions
--- a/packages/xo-server-audit/src/index.js
+++ b/packages/xo-server-audit/src/index.js
@ -68,6 +68,22 @@ const DEFAULT_BLOCKED_LIST = {
 }

 const LAST_ID = 'lastId'
+
+// interface Db {
+//   lastId: string
+//   [RecordId: string]: {
+//     data: object
+//     event: string
+//     id: strings
+//     previousId: string
+//     subject: {
+//       userId: string
+//       userIp: string
+//       userName: string
+//     }
+//     time: number
+//   }
+// }
 class Db extends Storage {
  constructor(db) {
    super()