Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshuaWise committed Dec 28, 2023
1 parent f347b86 commit 468387f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/readers.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ const reader = new LogReader(new LogDirectorySource(dirname));

- `minTimestamp` [<number>][number] The minimum timestamp (inclusive). This indicates where to start reading from. **Default:** `Date.now()`.
- `options` [<Object>][Object]
- `pollInterval` [<number>][number] The delay, in milliseconds, between each poll to the underlying log source (i.e., the filesystem). This controls how frequently new logs can be detected.
- `pollInterval` [<number>][number] The delay, in milliseconds, between each poll to the underlying log source (i.e., the filesystem). This controls how frequently new logs can be detected. **Default:** `200`.
- Returns: [<AsyncIterable][AsyncIterable][<LogEntry>][LogEntry][>][AsyncIterable]

Yields all logs with a timestamp greater than or equal to `minTimestamp`. New logs will be yielded indefinitely, until the returned [AsyncIterable][AsyncIterable] is stopped (i.e., by a `break` statement).
Expand Down

0 comments on commit 468387f

Please sign in to comment.