docs(log): document FileHandler #6175
Merged
+211
−13
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6175 +/- ##
=======================================
Coverage 96.51% 96.52%
=======================================
Files 538 538
Lines 41276 41302 +26
Branches 6162 6162
=======================================
+ Hits 39837 39865 +28
+ Misses 1395 1393 -2
Partials 44 44 ☔ View full report in Codecov by Sentry. |
efekrskl
commented
Nov 5, 2024
Comment on lines
+66
to
156
| /** Opened file to append logs to. | ||
| * @example Usage | ||
| * ```ts no-assert | ||
| * import { FileHandler } from "@std/log/file-handler"; | ||
| * | ||
| * const handler = new FileHandler("INFO", { filename: "./logs.txt" }); | ||
| * handler.setup(); | ||
| * handler.log('Hello, world!'); // Buffers the message, or writes it to the file depending on buffer state | ||
| * handler.flush(); // Manually flushes the buffer | ||
| * handler.destroy(); // Closes the file and removes listeners | ||
| * ``` | ||
| * **/ | ||
| [fileSymbol]: Deno.FsFile | undefined; | ||
| /** Buffer used to write to file. | ||
| * @example Usage | ||
| * ```ts no-assert | ||
| * import { FileHandler } from "@std/log/file-handler"; | ||
| * | ||
| * const handler = new FileHandler("INFO", { filename: "./logs.txt" }); | ||
| * handler.setup(); | ||
| * handler.log('Hello, world!'); // Buffers the message, or writes it to the file depending on buffer state | ||
| * handler.flush(); // Manually flushes the buffer | ||
| * handler.destroy(); // Closes the file and removes listeners | ||
| * ``` | ||
| * **/ | ||
| [bufSymbol]: Uint8Array; | ||
| /** Current position for pointer. | ||
| * @example Usage | ||
| * ```ts no-assert | ||
| * import { FileHandler } from "@std/log/file-handler"; | ||
| * | ||
| * const handler = new FileHandler("INFO", { filename: "./logs.txt" }); | ||
| * handler.setup(); | ||
| * handler.log('Hello, world!'); // Buffers the message, or writes it to the file depending on buffer state | ||
| * handler.flush(); // Manually flushes the buffer | ||
| * handler.destroy(); // Closes the file and removes listeners | ||
| * ``` | ||
| * **/ | ||
| [pointerSymbol] = 0; | ||
| /** Filename associated with the file being logged. | ||
| * @example Usage | ||
| * ```ts no-assert | ||
| * import { FileHandler } from "@std/log/file-handler"; | ||
| * | ||
| * const handler = new FileHandler("INFO", { filename: "./logs.txt" }); | ||
| * handler.setup(); | ||
| * handler.log('Hello, world!'); // Buffers the message, or writes it to the file depending on buffer state | ||
| * handler.flush(); // Manually flushes the buffer | ||
| * handler.destroy(); // Closes the file and removes listeners | ||
| * ``` | ||
| * **/ | ||
| [filenameSymbol]: string; | ||
| /** Current log mode. | ||
| * @example Usage | ||
| * ```ts no-assert | ||
| * import { FileHandler } from "@std/log/file-handler"; | ||
| * | ||
| * const handler = new FileHandler("INFO", { filename: "./logs.txt" }); | ||
| * handler.setup(); | ||
| * handler.log('Hello, world!'); // Buffers the message, or writes it to the file depending on buffer state | ||
| * handler.flush(); // Manually flushes the buffer | ||
| * handler.destroy(); // Closes the file and removes listeners | ||
| * ``` | ||
| * **/ | ||
| [modeSymbol]: LogMode; | ||
| /** File open options. | ||
| * @example Usage | ||
| * ```ts no-assert | ||
| * import { FileHandler } from "@std/log/file-handler"; | ||
| * | ||
| * const handler = new FileHandler("INFO", { filename: "./logs.txt" }); | ||
| * handler.setup(); | ||
| * handler.log('Hello, world!'); // Buffers the message, or writes it to the file depending on buffer state | ||
| * handler.flush(); // Manually flushes the buffer | ||
| * handler.destroy(); // Closes the file and removes listeners | ||
| * ``` | ||
| * **/ | ||
| [openOptionsSymbol]: Deno.OpenOptions; | ||
| /** Text encoder. | ||
| * @example Usage | ||
| * ```ts no-assert | ||
| * import { FileHandler } from "@std/log/file-handler"; | ||
| * | ||
| * const handler = new FileHandler("INFO", { filename: "./logs.txt" }); | ||
| * handler.setup(); | ||
| * handler.log('Hello, world!'); // Buffers the message, or writes it to the file depending on buffer state | ||
| * handler.flush(); // Manually flushes the buffer | ||
| * handler.destroy(); // Closes the file and removes listeners | ||
| * ``` | ||
| * **/ | ||
| [encoderSymbol]: TextEncoder = new TextEncoder(); |
There was a problem hiding this comment.
Some of these symbols should probably be private properties, but since they are not, linting requires them to be documented still. I'm not sure how to handle this better.
There was a problem hiding this comment.
Probably that's the issue of linter (and it could be also an issue of doc generator), but I think it's fine for now for this PR
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documents
FileHandlerfor #3764