Skip to content

Commit

Permalink
Merge ce1fb76 into b675f30
Browse files Browse the repository at this point in the history
  • Loading branch information
GiedriusGrabauskas committed Nov 27, 2017
2 parents b675f30 + ce1fb76 commit 919d749
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 1 deletion.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -105,6 +124,16 @@ 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. |

### 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.

TODO

## License
Expand Down
2 changes: 1 addition & 1 deletion src/builders/logger-configuration-builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down

0 comments on commit 919d749

Please sign in to comment.