summaryrefslogtreecommitdiff
path: root/std/log/README.md
diff options
context:
space:
mode:
authorChris Knight <cknight1234@gmail.com>2020-06-06 04:39:49 +0100
committerGitHub <noreply@github.com>2020-06-05 23:39:49 -0400
commitc137b11abfb946ef72a5fcb27e11e0b286a33be3 (patch)
tree3034ec105668d543ac8dda541718760d693d529a /std/log/README.md
parent93175b7a79e09381ea556539f10cde9eaa61af89 (diff)
fix: revert setInterval log flushing as it prevents process completion (#6127)
Diffstat (limited to 'std/log/README.md')
-rw-r--r--std/log/README.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/std/log/README.md b/std/log/README.md
index 4c69784f9..3989d1fb7 100644
--- a/std/log/README.md
+++ b/std/log/README.md
@@ -107,10 +107,10 @@ interface HandlerOptions {
#### `FileHandler`
This handler will output to a file using an optional mode (default is `a`, e.g.
-append). The file will grow indefinitely. It uses a buffer for writing to file
-and will automatically flush every 30 seconds, though you can trigger this
-yourself with `fileHandler.flush()`. Log messages with a log level greater than
-error are immediately flushed. This logger takes `FileOptions`:
+append). The file will grow indefinitely. It uses a buffer for writing to file.
+Logs can be manually flushed with `fileHandler.flush()`. Log messages with a log
+level greater than error are immediately flushed. Logs are also flushed on
+process completion. This logger takes `FileOptions`:
```typescript
interface FileHandlerOptions {
@@ -151,10 +151,10 @@ backups to keep), `log.txt.1` would be renamed to `log.txt.2`, `log.txt` would
be renamed to `log.txt.1` and finally `log.txt` would be created from scratch
where the new log message would be written.
-This handler uses a buffer for writing to file and will automatically flush
-every 30 seconds, though you can trigger this yourself with
-`fileHandler.flush()`. Log messages with a log level greater than error are
-immediately flushed.
+This handler uses a buffer for writing log messages to file. Logs can be
+manually flushed with `fileHandler.flush()`. Log messages with a log level
+greater than ERROR are immediately flushed. Logs are also flushed on process
+completion.
Options for this handler are: