@typed/logger

A generic interface for logging data

Index

Enumerations

LogLevel

Interfaces

Logger

Type aliases

Functions

Type aliases

CreateConsoleLoggerOptions

CreateConsoleLoggerOptions: { clock: Clock; logLevel: LogLevel }

Type declaration

Readonly clock: Clock
Readonly logLevel: LogLevel

CreateTestLoggerOptions

CreateTestLoggerOptions: { clock: Clock; logLevel: LogLevel }

Type declaration

Readonly clock: Clock
Readonly logLevel: LogLevel

Log

Log: { message: string; type: "log" } | { message: string; type: "error" } | { type: "clear" } | { message: string; type: "info" } | { message: string; type: "debug" } | { label: string; time: number; type: "timeStart" } | { label: string; time: number; type: "timeEnd" }

LoggerEnv

LoggerEnv: { logger: Logger }

Type declaration

Readonly logger: Logger

Logs

Logs: ReadonlyArray<Log>

TestLogger

TestLogger: { getLogs: () => Logs; logger: Logger }

Type declaration

Readonly getLogs: () => Logs
- - (): Logs
  - Returns Logs
Readonly logger: Logger

Functions

clear

clear(): Effects<LoggerEnv, void>

- Defined in packages/logger/source/clear.ts:4
Returns Effects<LoggerEnv, void>

createConsoleLogger

createConsoleLogger(__namedParameters: { clock: Clock; logLevel: LogLevel }): Logger

- Defined in packages/logger/source/createConsoleLogger.ts:13
Create a logger that wraps the console.

Parameters
- __namedParameters: { clock: Clock; logLevel: LogLevel }
  - clock: Clock
  - logLevel: LogLevel
Returns Logger

createTestLogger

createTestLogger(__namedParameters: { clock: Clock; logLevel: LogLevel }): TestLogger

- Defined in packages/logger/source/createTestLogger.ts:30
Create a logger suitable for testing environments.

Parameters
- __namedParameters: { clock: Clock; logLevel: LogLevel }
  - clock: Clock
  - logLevel: LogLevel
Returns TestLogger

debug

debug(msg: string): Effects<LoggerEnv, void>

- Defined in packages/logger/source/debug.ts:4
Parameters
- msg: string
Returns Effects<LoggerEnv, void>

error

error(msg: string): Effects<LoggerEnv, void>

- Defined in packages/logger/source/error.ts:4
Parameters
- msg: string
Returns Effects<LoggerEnv, void>

info

info(msg: string): Effects<LoggerEnv, void>

- Defined in packages/logger/source/info.ts:4
Parameters
- msg: string
Returns Effects<LoggerEnv, void>

log

log(msg: string): Effects<LoggerEnv, void>

- Defined in packages/logger/source/log.ts:4
Parameters
- msg: string
Returns Effects<LoggerEnv, void>

time

time(label: string): Effects<LoggerEnv, Effects<unknown, number>>

- Defined in packages/logger/source/time.ts:4
Parameters
- label: string
Returns Effects<LoggerEnv, Effects<unknown, number>>

@typed/logger

Index

Enumerations

Interfaces

Type aliases

Functions

Type aliases

CreateConsoleLoggerOptions

Type declaration

Readonly clock: Clock

Readonly logLevel: LogLevel

CreateTestLoggerOptions

Type declaration

Readonly clock: Clock

Readonly logLevel: LogLevel

Log

LoggerEnv

Type declaration

Readonly logger: Logger

Logs

TestLogger

Type declaration

Readonly getLogs: () => Logs

Returns Logs

Readonly logger: Logger

Functions

clear

Returns Effects<LoggerEnv, void>

createConsoleLogger

Parameters

__namedParameters: { clock: Clock; logLevel: LogLevel }

clock: Clock

logLevel: LogLevel

Returns Logger

createTestLogger

Parameters

__namedParameters: { clock: Clock; logLevel: LogLevel }

clock: Clock

logLevel: LogLevel

Returns TestLogger

debug

Parameters

msg: string

Returns Effects<LoggerEnv, void>

error

Parameters

msg: string

Returns Effects<LoggerEnv, void>

info

Parameters

msg: string

Returns Effects<LoggerEnv, void>

log

Parameters

msg: string

Returns Effects<LoggerEnv, void>

time

Parameters

label: string

Returns Effects<LoggerEnv, Effects<unknown, number>>