1.0.0 • Published 8 years ago
autologger v1.0.0
autologger
Javascript utility for automatic logging of functions and classes.
Install
$ npm install autologger --saveUsage
const Autolog = require('autologger');
const autolog = Autolog(options)(type)(logger);
let target = autolog(target);| Variable | Type | Required |
|---|---|---|
| options | object | no |
| type | string | yes |
| logger | object | yes |
| target | function or class | yes |
options
Logs the wrapping of a variable by an automatic logger. Must contain two properties:
| Properties | Type | Required |
|---|---|---|
| preprocess | function | no |
| postprocess | function | no |
type
The type of the variable to which automatic logging is applied. One of the following values:
- class
- function
- method
logger
Logs the call steps. Must contain two properties:
| Properties | Type | Required |
|---|---|---|
| before | function | yes |
| after | function | yes |
target
The function or class to which automatic logging will be applied.
Example
Logger
const logger = {
before: console.log,
after: console.log,
};Function
const autolog = Autolog()('function')(logger);
let example = autolog(function example() { /* ... */ });Class
const autolog = Autolog()('class')(logger);
let Example = autolog(class Example {
/* ... */
});with decorators
const autolog = Autolog()('class')(logger);
@autolog
class Example {
/* ... */
}Class method
const autolog = Autolog()('method')(logger);
class Example {
@autolog
test() { /* ... */ }
}License
This project is licensed under MIT.