Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(log): do not exec file handler examples in CI #6183

Merged
merged 1 commit into from
Nov 13, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions log/file_handler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export interface FileHandlerOptions extends BaseHandlerOptions {
* This handler requires `--allow-write` permission on the log file.
*
* @example Usage
* ```ts no-assert
* ```ts no-assert ignore
* import { FileHandler } from "@std/log/file-handler";
*
* const handler = new FileHandler("INFO", { filename: "./logs.txt" });
Expand All @@ -65,7 +65,7 @@ export interface FileHandlerOptions extends BaseHandlerOptions {
export class FileHandler extends BaseHandler {
/** Opened file to append logs to.
* @example Usage
* ```ts no-assert
* ```ts no-assert ignore
* import { FileHandler } from "@std/log/file-handler";
*
* const handler = new FileHandler("INFO", { filename: "./logs.txt" });
Expand All @@ -78,7 +78,7 @@ export class FileHandler extends BaseHandler {
[fileSymbol]: Deno.FsFile | undefined;
/** Buffer used to write to file.
* @example Usage
* ```ts no-assert
* ```ts no-assert ignore
* import { FileHandler } from "@std/log/file-handler";
*
* const handler = new FileHandler("INFO", { filename: "./logs.txt" });
Expand All @@ -91,7 +91,7 @@ export class FileHandler extends BaseHandler {
[bufSymbol]: Uint8Array;
/** Current position for pointer.
* @example Usage
* ```ts no-assert
* ```ts no-assert ignore
* import { FileHandler } from "@std/log/file-handler";
*
* const handler = new FileHandler("INFO", { filename: "./logs.txt" });
Expand All @@ -104,7 +104,7 @@ export class FileHandler extends BaseHandler {
[pointerSymbol] = 0;
/** Filename associated with the file being logged.
* @example Usage
* ```ts no-assert
* ```ts no-assert ignore
* import { FileHandler } from "@std/log/file-handler";
*
* const handler = new FileHandler("INFO", { filename: "./logs.txt" });
Expand All @@ -117,7 +117,7 @@ export class FileHandler extends BaseHandler {
[filenameSymbol]: string;
/** Current log mode.
* @example Usage
* ```ts no-assert
* ```ts no-assert ignore
* import { FileHandler } from "@std/log/file-handler";
*
* const handler = new FileHandler("INFO", { filename: "./logs.txt" });
Expand All @@ -130,7 +130,7 @@ export class FileHandler extends BaseHandler {
[modeSymbol]: LogMode;
/** File open options.
* @example Usage
* ```ts no-assert
* ```ts no-assert ignore
* import { FileHandler } from "@std/log/file-handler";
*
* const handler = new FileHandler("INFO", { filename: "./logs.txt" });
Expand All @@ -143,7 +143,7 @@ export class FileHandler extends BaseHandler {
[openOptionsSymbol]: Deno.OpenOptions;
/** Text encoder.
* @example Usage
* ```ts no-assert
* ```ts no-assert ignore
* import { FileHandler } from "@std/log/file-handler";
*
* const handler = new FileHandler("INFO", { filename: "./logs.txt" });
Expand Down Expand Up @@ -183,7 +183,7 @@ export class FileHandler extends BaseHandler {
* Sets up the file handler by opening the specified file and initializing resources.
*
* @example Usage
* ```ts no-assert
* ```ts no-assert ignore
* import { FileHandler } from "@std/log/file-handler";
*
* const handler = new FileHandler("INFO", { filename: "./logs.txt" });
Expand All @@ -207,7 +207,7 @@ export class FileHandler extends BaseHandler {
* @param logRecord Log record to handle.
*
* @example Usage
* ```ts
* ```ts ignore
* import { FileHandler } from "@std/log/file-handler";
* import { assertInstanceOf } from "@std/assert/instance-of";
* import { LogLevels } from "./levels.ts";
Expand Down Expand Up @@ -245,7 +245,7 @@ export class FileHandler extends BaseHandler {
* @param msg The message to log.
*
* @example Usage
* ```ts
* ```ts ignore
* import { FileHandler } from "@std/log/file-handler";
* import { assertInstanceOf } from "@std/assert/instance-of";
*
Expand Down Expand Up @@ -275,7 +275,7 @@ export class FileHandler extends BaseHandler {
* Immediately writes the contents of the buffer to the previously opened file.
*
* @example Usage
* ```ts
* ```ts ignore
* import { FileHandler } from "@std/log/file-handler";
* import { assertInstanceOf } from "@std/assert/instance-of";
*
Expand Down Expand Up @@ -308,7 +308,7 @@ export class FileHandler extends BaseHandler {
* Destroys the handler, performing any cleanup that is required and closes the file handler.
*
* @example Usage
* ```ts
* ```ts ignore
* import { FileHandler } from "@std/log/file-handler";
* import { assertInstanceOf } from "@std/assert/instance-of";
*
Expand Down