Issue #109: Update documentation for LogLevel.Off

Author: mreuvers

README.md

@@ -5,12 +5,13 @@ TypeScript logging can be used to add logging to your web or node project.
 **_Version 2 of typescript-logging has been released, this version has been written from scratch and is
 not compatible with version 1 (see migration)._**
 
-There are two different flavors available to use. Please visit the documentation below and pick the one you prefer.
+There are two different flavors available to use. Please visit the documentation of the links below and pick the one you
+prefer.
 
 * The [typescript-logging-category-style](./category-style/README.MD) flavor.
 * The [typescript-logging-log4ts-style](./log4ts-style/README.MD) flavor.
 
-The following general sections are available:
+The following sections are available:
 
 * [Getting started](#getting-started)
 * [Build](#build)

category-style/README.MD

@@ -149,9 +149,12 @@ A logger can log on different `LogLevels`:
 - Warn
 - Error
 - Fatal
+- Off
 
-Each level has a matching function on the Logger, for example `trace` for Trace and `debug` for Debug. The signatures of
-the function are the same for all of them. This shows the signatures for debug.
+Each level except 'Off' has a matching function on the Logger, for example `trace` for Trace and `debug` for Debug. The
+signatures of the function are the same for all of them. Note that the level 'Off' turns logging off completely.
+
+This shows the signatures for debug.
 
 ```typescript
 interface CoreLogger {

documentation/change_log.md

@@ -3,6 +3,9 @@
 This page describes the relevant changes per version since 2.0.0 release.
 
 * 2.1.0
+    * Add support for LogLevel.Off, this allows logging to be turned off complete.
+      Issue https://github.com/vauxite-org/typescript-logging/issues/109. Please be sure to
+      read the [migration guide](./migration.md) as this change may have an effect.
     * Dev dependencies updated (to get rid of vulnerability warnings), these have no influence on the production
       release and are used during the build only.
 

documentation/migration.md

@@ -2,6 +2,14 @@
 
 This section provides an overview of breaking changes, when migrating from an older typescript-logging version.
 
+## Version 2.0.x -> 2.1.x
+
+Enum value LogLevel.Off has been added. It is unlikely to cause a problem to existing code, however if you
+do switch on LogLevel in the code somewhere and/or check on LogLevel, the compilation of your project may fail
+or the logic is now wrong.
+
+To find out if you do, you can search for '.logLevel' (it is a property on a logger).
+
 ## Version 1.0.x -> 2.0.x
 
 As version 2 is a complete rewrite from scratch there is no direct migration path although certain things are still

log4ts-style/README.MD

@@ -137,9 +137,12 @@ A logger can log on different `LogLevels`:
 - Warn
 - Error
 - Fatal
+- Off
 
-Each level has a matching function on the Logger, for example `trace` for Trace and `debug` for Debug. The signatures of
-the function are the same for all of them. This shows the signatures for debug.
+Each level except 'Off' has a matching function on the Logger, for example `trace` for Trace and `debug` for Debug. The
+signatures of the function are the same for all of them. Note that the level 'Off' turns logging off completely.
+
+This shows the signatures for debug.
 
 ```typescript
 interface CoreLogger {
@@ -177,7 +180,8 @@ A Log4TSProvider created without any options logs on `LogLevel.Error` and uses a
 console. Messages are formatted in a default sane format (see above for an example).
 
 This code snippet creates a Log4TSProvider with default settings, the `groups` property is required to be specified and
-in this case we match every namespace. Note we also specify an identifier, it is recommended to specify the identifier if
+in this case we match every namespace. Note we also specify an identifier, it is recommended to specify the identifier
+if
 you intend to make use of the dynamic control (see in later sections).
 
 ```typescript
@@ -302,7 +306,9 @@ export interface LogChannel {
 }
 ```
 
-Essentially it expects you to provide the `write` function. The `type` (a [discriminating union](https://www.typescriptlang.org/docs/handbook/2/narrowing.html#discriminated-unions)) is solely there to
+Essentially it expects you to provide the `write` function. The `type` (
+a [discriminating union](https://www.typescriptlang.org/docs/handbook/2/narrowing.html#discriminated-unions)) is solely
+there to
 distinguish between the different channels and is always `"LogChannel"` for a `LogChannel`. The write function is called
 with for each `LogMessage`, and contains a message and optional error (formatted as stack). We have
 already seen how to create a custom LogChannel in the previous section (have a look above if you didn't read it yet).