Skip to content

Commit 3ec22b5

Browse files
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.
1 parent b675f30 commit 3ec22b5

File tree

4 files changed

+44
-11
lines changed

4 files changed

+44
-11
lines changed

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,25 @@ const logger = new LoggerBuilder({
6161
});
6262
```
6363

64+
### Creating logger handler
65+
66+
```ts
67+
import { MessageHandlerBase, LogLevel, LoggerBuilder, LoggerConfigurationBuilder } from "simplr-logger";
68+
69+
class MyMessageHandler extends MessageHandlerBase {
70+
public HandleMessage(level: LogLevel, timestamp: number, messages: any[]): void {
71+
console.log(...messages);
72+
}
73+
}
74+
75+
const config = new LoggerConfigurationBuilder()
76+
.AddWriteMessageHandler({ Handler: new MyMessageHandler(), LogLevel: LogLevel.Trace })
77+
.Build();
78+
79+
const logger = new LoggerBuilder(config);
80+
81+
```
82+
6483
### Using logger
6584

6685
#### Logging with methods
@@ -105,7 +124,15 @@ logger.UpdateConfiguration(builder => builder.SetPrefix("[new prefix]").Build(),
105124
| 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. |
106125
| 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. |
107126

108-
TODO
127+
### Configuration
128+
129+
| Name | Default value | Description |
130+
|-----------------------|----------------------------------------------------------------------------|--------------------------------------------------------------------|
131+
| WriteMessageHandlers | `[{ Handler: new ConsoleMessageHandler() }]` | Message handlers list. ⁽¹⁾ |
132+
| DefaultLogLevel | `{ LogLevel: LogLevel.Warning, LogLevelIsBitMask: false }` | Log level or log levels in bit mask value. |
133+
| Prefix | `undefined` | Custom message, which will be injected into the start of messages. |
134+
135+
`(1)` - The default value is only available if configuration property is not set.
109136

110137
## License
111138

package-lock.json

Lines changed: 13 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
},
5757
"homepage": "https://github.com/SimplrJS/simplr-logger#readme",
5858
"devDependencies": {
59-
"@types/jest": "^21.1.7",
59+
"@types/jest": "^21.1.8",
6060
"@types/node": "^8.0.53",
6161
"coveralls": "^3.0.0",
6262
"jest": "^21.2.1",
@@ -66,7 +66,7 @@
6666
"ts-loader": "^3.1.1",
6767
"tslint": "^5.8.0",
6868
"typescript": "^2.6.1",
69-
"uglify-js": "^3.1.9",
69+
"uglify-js": "^3.2.0",
7070
"webpack": "^3.8.1"
7171
},
7272
"dependencies": {

src/builders/logger-configuration-builder.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ export class LoggerConfigurationBuilder {
5959
* Add a list of write message handlers.
6060
*
6161
* @param handlers Write message handlers list.
62-
* @param defaultLogLevel Default log level only for this list of handler.
62+
* @param defaultLogLevel Default log level only for this list of handlers.
6363
*/
6464
public AddWriteMessageHandlers(handlers: WriteMessageHandlerBuilder[], defaultLogLevel?: LogLevel | LogLevel[]): this {
6565
if (defaultLogLevel != null) {

0 commit comments

Comments
 (0)