Updated descriptions (#12)

* Fixed description. * Added section for creating handler in README. * Added configuration values in README. * Updated README. * Updated default value of WriteMessageHandlers in readme. * Updated README. * Removed TODO from README * Updated package versions.
SimplrJS · Nov 27, 2017 · 3ec22b5 · 3ec22b5
1 parent b675f30
commit 3ec22b5
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -61,6  61,25 @@ const logger = new LoggerBuilder({
 });
 ```
 
 ### Creating logger handler
 
 ```ts
 import { MessageHandlerBase, LogLevel, LoggerBuilder, LoggerConfigurationBuilder } from "simplr-logger";
 
 class MyMessageHandler extends MessageHandlerBase {
     public HandleMessage(level: LogLevel, timestamp: number, messages: any[]): void {
         console.log(...messages);
     }
 }
 
 const config = new LoggerConfigurationBuilder()
     .AddWriteMessageHandler({ Handler: new MyMessageHandler(), LogLevel: LogLevel.Trace })
     .Build();
 
 const logger = new LoggerBuilder(config);
 
 ```
 
 ### Using logger
 
 #### Logging with methods
@@ -105,7  124,15 @@ logger.UpdateConfiguration(builder => builder.SetPrefix("[new prefix]").Build(),
 |    Debug    |   16  | Logs that are used for interactive investigation during development. These logs should primarily contain information useful for debugging and have no long-term value.                               |
 |    Trace    |   32  | Logs that contain the most detailed messages. These messages may contain sensitive application data. These messages are disabled by default and should never be enabled in a production environment. |
 
-TODO
 ### Configuration
 
 | Name                  | Default value                                                              | Description                                                        |
 |-----------------------|----------------------------------------------------------------------------|--------------------------------------------------------------------|
 |  WriteMessageHandlers | `[{ Handler: new ConsoleMessageHandler() }]`                               | Message handlers list. ⁽¹⁾                                         |
 |  DefaultLogLevel      | `{ LogLevel: LogLevel.Warning, LogLevelIsBitMask: false }`                 | Log level or log levels in bit mask value.                         |
 |  Prefix               | `undefined`                                                                | Custom message, which will be injected into the start of messages. |
 
 `(1)` - The default value is only available if configuration property is not set.
 
 ## License
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -56,7  56,7 @@
   },
   "homepage": "https://github.com/SimplrJS/simplr-logger#readme",
   "devDependencies": {
-    "@types/jest": "^21.1.7",
     "@types/jest": "^21.1.8",
     "@types/node": "^8.0.53",
     "coveralls": "^3.0.0",
     "jest": "^21.2.1",
@@ -66,7  66,7 @@
     "ts-loader": "^3.1.1",
     "tslint": "^5.8.0",
     "typescript": "^2.6.1",
-    "uglify-js": "^3.1.9",
     "uglify-js": "^3.2.0",
     "webpack": "^3.8.1"
   },
   "dependencies": {

diff --git a/src/builders/logger-configuration-builder.ts b/src/builders/logger-configuration-builder.ts
@@ -59,7  59,7 @@ export class LoggerConfigurationBuilder {
      * Add a list of write message handlers.
      *
      * @param handlers Write message handlers list.
-     * @param defaultLogLevel Default log level only for this list of handler.
      * @param defaultLogLevel Default log level only for this list of handlers.
      */
     public AddWriteMessageHandlers(handlers: WriteMessageHandlerBuilder[], defaultLogLevel?: LogLevel | LogLevel[]): this {
         if (defaultLogLevel != null) {