Adds documentations for adapters and main constructors (#4951)
* wip * Adds documentations for adapters, and constructors * nits * nit
This commit is contained in:
@@ -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 */) {}
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user