Adds documentations for adapters and main constructors (#4951)

* wip

* Adds documentations for adapters, and constructors

* nits

* nit
This commit is contained in:
Florent Vilmart
2018-08-10 15:51:31 -04:00
parent 0571675fcd
commit 942b9b5b1a
17 changed files with 3316 additions and 2708 deletions

View File

@@ -1,15 +1,21 @@
/*eslint no-unused-vars: "off"*/
// Logger Adapter
//
// Allows you to change the logger mechanism
//
// Adapter classes must implement the following functions:
// * log() {}
// * query(options, callback) /* optional */
// Default is WinstonLoggerAdapter.js
/**
* @module Adapters
*/
/**
* @interface LoggerAdapter
* Logger Adapter
* Allows you to change the logger mechanism
* Default is WinstonLoggerAdapter.js
*/
export class LoggerAdapter {
constructor(options) {}
/**
* log
* @param {String} level
* @param {String} message
* @param {Object} metadata
*/
log(level, message, /* meta */) {}
}