lib/effects/logger
Esta página aún no está disponible en tu idioma.
Classes
Section titled “Classes”S48Logger
Section titled “S48Logger”Defined in: studiocms/packages/studiocms/src/lib/effects/logger.ts:67^
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new S48Logger(logging: LogOptions, label: string): S48LoggerDefined in: studiocms/packages/studiocms/src/lib/effects/logger.ts:71^
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/lib/effects/logger.ts:69^
options
Section titled “options”options: LogOptions;Defined in: studiocms/packages/studiocms/src/lib/effects/logger.ts:68^
Methods
Section titled “Methods”debug()
Section titled “debug()”debug(message: string): voidDefined in: studiocms/packages/studiocms/src/lib/effects/logger.ts:92^
Parameters
Section titled “Parameters”message
Section titled “message”string
Returns
Section titled “Returns”void
error()
Section titled “error()”error(message: string): voidDefined in: studiocms/packages/studiocms/src/lib/effects/logger.ts:89^
Parameters
Section titled “Parameters”message
Section titled “message”string
Returns
Section titled “Returns”void
fork()
Section titled “fork()”fork(label: string): S48LoggerDefined in: studiocms/packages/studiocms/src/lib/effects/logger.ts:79^
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): voidDefined in: studiocms/packages/studiocms/src/lib/effects/logger.ts:83^
Parameters
Section titled “Parameters”message
Section titled “message”string
Returns
Section titled “Returns”void
warn()
Section titled “warn()”warn(message: string): voidDefined in: studiocms/packages/studiocms/src/lib/effects/logger.ts:86^
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/lib/effects/logger.ts:29^
Properties
Section titled “Properties”level: LoggerLevel;Defined in: studiocms/packages/studiocms/src/lib/effects/logger.ts:30^
Type Aliases
Section titled “Type Aliases”LoggerLevel
Section titled “LoggerLevel”type LoggerLevel = "debug" | "info" | "warn" | "error" | "silent";Defined in: studiocms/packages/studiocms/src/lib/effects/logger.ts:19^
Variables
Section titled “Variables”errorTap
Section titled “errorTap”const errorTap: any;Defined in: studiocms/packages/studiocms/src/lib/effects/logger.ts:267^
A utility function that logs an error message when an Effect.fail() is executed.
This function is curried and can be used in two forms:
- By providing a
messagefirst, which returns a function that takes anEffectand logs the error message. - By providing both the
Effectand themessagedirectly.
Template
Section titled “Template”The type of the success value of the Effect.
Template
Section titled “Template”The type of the error value of the Effect.
Template
Section titled “Template”The type of the environment required by the Effect.
The error message to log. Can be a single value or an array of values.
The Effect to which the error logging will be applied.
Returns
Section titled “Returns”A new Effect that logs the provided error message when executed.
levels
Section titled “levels”const levels: Record<LoggerLevel, number>;Defined in: studiocms/packages/studiocms/src/lib/effects/logger.ts:21^
pipeLogger
Section titled “pipeLogger”const pipeLogger: any;Defined in: studiocms/packages/studiocms/src/lib/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/lib/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/lib/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”Function
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.
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): anyDefined in: studiocms/packages/studiocms/src/lib/effects/logger.ts:40^
Parameters
Section titled “Parameters”label?
Section titled “label?”string
Returns
Section titled “Returns”any