utils/effects/logger
Ce contenu n’est pas encore disponible dans votre langue.
Classes
Section titled “Classes”S48Logger
Section titled “S48Logger”Defined in: studiocms/packages/studiocms/src/utils/effects/logger.ts:65^
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new S48Logger(logging: LogOptions, label: string): S48Logger;Defined in: studiocms/packages/studiocms/src/utils/effects/logger.ts:69^
Parameters
Section titled “Parameters”logging
Section titled “logging”string
Returns
Section titled “Returns”Properties
Section titled “Properties”label: string;Defined in: studiocms/packages/studiocms/src/utils/effects/logger.ts:67^
options
Section titled “options”options: LogOptions;Defined in: studiocms/packages/studiocms/src/utils/effects/logger.ts:66^
Methods
Section titled “Methods”debug()
Section titled “debug()”debug(message: string): void;Defined in: studiocms/packages/studiocms/src/utils/effects/logger.ts:90^
Parameters
Section titled “Parameters”message
Section titled “message”string
Returns
Section titled “Returns”void
error()
Section titled “error()”error(message: string): void;Defined in: studiocms/packages/studiocms/src/utils/effects/logger.ts:87^
Parameters
Section titled “Parameters”message
Section titled “message”string
Returns
Section titled “Returns”void
fork()
Section titled “fork()”fork(label: string): S48Logger;Defined in: studiocms/packages/studiocms/src/utils/effects/logger.ts:77^
Creates a new logger instance with a new label, but the same log options.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”info()
Section titled “info()”info(message: string): void;Defined in: studiocms/packages/studiocms/src/utils/effects/logger.ts:81^
Parameters
Section titled “Parameters”message
Section titled “message”string
Returns
Section titled “Returns”void
warn()
Section titled “warn()”warn(message: string): void;Defined in: studiocms/packages/studiocms/src/utils/effects/logger.ts:84^
Parameters
Section titled “Parameters”message
Section titled “message”string
Returns
Section titled “Returns”void
Interfaces
Section titled “Interfaces”LogOptions
Section titled “LogOptions”Defined in: studiocms/packages/studiocms/src/utils/effects/logger.ts:25^
Properties
Section titled “Properties”level: LoggerLevel;Defined in: studiocms/packages/studiocms/src/utils/effects/logger.ts:26^
Type Aliases
Section titled “Type Aliases”LoggerLevel
Section titled “LoggerLevel”type LoggerLevel = "debug" | "info" | "warn" | "error" | "silent";Defined in: studiocms/packages/studiocms/src/utils/effects/logger.ts:15^
Variables
Section titled “Variables”levels
Section titled “levels”const levels: Record<LoggerLevel, number>;Defined in: studiocms/packages/studiocms/src/utils/effects/logger.ts:17^
loggerCache
Section titled “loggerCache”const loggerCache: Map<string, S48Logger>;Defined in: studiocms/packages/studiocms/src/utils/effects/logger.ts:13^
A cache that stores instances of AstroIntegrationLogger associated with their string keys.
This is used to avoid creating multiple logger instances for the same key.
pipeLogger
Section titled “pipeLogger”const pipeLogger: any;Defined in: studiocms/packages/studiocms/src/utils/effects/logger.ts:210^
Wraps an Effect with additional logging functionality.
This function applies a runtime logger and a log span to the provided Effect,
enabling detailed logging for debugging and monitoring purposes.
A string label used to identify the log entries and span.
The Effect to be wrapped with logging functionality.
Returns
Section titled “Returns”A new Effect that includes runtime logging and a log span.
runtimeLogger
Section titled “runtimeLogger”const runtimeLogger: any;Defined in: studiocms/packages/studiocms/src/utils/effects/logger.ts:194^
Creates a runtime logger effect transformer that applies a specific label to log messages and configures the logging behavior based on the provided log level.
A string label to associate with the logger for identifying log messages.
Returns
Section titled “Returns”A higher-order function that takes an Effect and returns a new Effect with
the logger configuration applied.
Functions
Section titled “Functions”genLogger()
Section titled “genLogger()”function genLogger(label: string): <Eff, AEff>(f: (resume: Adapter) => Generator<Eff, AEff, never>) => Effect<AEff, [Eff] extends [never] ? never : [Eff] extends [YieldWrap<Effect<_A, E, _R>>] ? E : never, [Eff] extends [never] ? never : [Eff] extends [YieldWrap<Effect<_A, _E, R>>] ? R : never>;Defined in: studiocms/packages/studiocms/src/utils/effects/logger.ts:232^
Generates a logger function that wraps an effectful generator function with logging capabilities.
Parameters
Section titled “Parameters”string
A string label used to identify the logger.
Returns
Section titled “Returns”A function that takes a generator function f and returns an Effect.Effect instance.
The returned function accepts a generator function f that yields wrapped effects (YieldWrap<Effect.Effect>).
It logs the execution of the generator function and its effects using the provided label.
<Eff, AEff>(f: (resume: Adapter) => Generator<Eff, AEff, never>): Effect<AEff, [Eff] extends [never] ? never : [Eff] extends [YieldWrap<Effect<_A, E, _R>>] ? E : never, [Eff] extends [never] ? never : [Eff] extends [YieldWrap<Effect<_A, _E, R>>] ? R : never>;Type Parameters
Section titled “Type Parameters”Eff extends YieldWrap<Effect<any, any, any>>
AEff
Parameters
Section titled “Parameters”(resume: Adapter) => Generator<Eff, AEff, never>
Returns
Section titled “Returns”Effect<AEff, [Eff] extends [never] ? never : [Eff] extends [YieldWrap<Effect<_A, E, _R>>] ? E : never, [Eff] extends [never] ? never : [Eff] extends [YieldWrap<Effect<_A, _E, R>>] ? R : never>
getEventPrefix()
Section titled “getEventPrefix()”function getEventPrefix(level: LoggerLevel, label?: string): any;Defined in: studiocms/packages/studiocms/src/utils/effects/logger.ts:36^
Parameters
Section titled “Parameters”label?
Section titled “label?”string
Returns
Section titled “Returns”any
stripNameFromLabel()
Section titled “stripNameFromLabel()”function stripNameFromLabel(label: string): string;Defined in: studiocms/packages/studiocms/src/utils/effects/logger.ts:4^
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”string