index overview
Added in v0.1.0
Table of contents
constructors
LogEntry
Signature
export declare const LogEntry: (message: string, date: Date, level: LogLevel, payload: JsonRecord) => LogEntry
Added in v0.1.0
withShow
Signature
export declare const withShow: (show: Show<LogEntry>) => (fa: LoggerIO<string>) => Logger
Example
import * as C from 'fp-ts/Console'
import { pipe } from 'fp-ts/function'
import * as L from 'logger-fp-ts'
const logger = pipe(C.log, L.withShow(L.ShowLogEntry))
Added in v0.1.2
destructors
match
Signature
export declare const match: <R>(patterns: {
readonly DEBUG: (entry: LogEntry) => R
readonly INFO: (entry: LogEntry) => R
readonly WARN: (entry: LogEntry) => R
readonly ERROR: (entry: LogEntry) => R
}) => (entry: LogEntry) => R
Added in v0.1.2
instances
EqLogEntry
Signature
export declare const EqLogEntry: E.Eq<LogEntry>
Added in v0.1.2
JsonShowLogEntry
Signature
export declare const JsonShowLogEntry: S.Show<LogEntry>
Added in v0.2.2
ShowLogEntry
Signature
export declare const ShowLogEntry: S.Show<LogEntry>
Added in v0.1.2
debug
Log a ‘DEBUG’ message.
Signature
export declare const debug: (message: string) => ReaderIO<LoggerEnv, void>
Added in v0.1.0
debugP
Log a ‘DEBUG’ message with a payload.
Signature
export declare const debugP: (message: string) => (payload: JsonRecord) => ReaderIO<LoggerEnv, void>
Added in v0.2.0
error
Log an ‘ERROR’ message.
Signature
export declare const error: (message: string) => ReaderIO<LoggerEnv, void>
Added in v0.1.0
errorP
Log an ‘ERROR’ message with a payload.
Signature
export declare const errorP: (message: string) => (payload: JsonRecord) => ReaderIO<LoggerEnv, void>
Added in v0.2.0
getColoredShow
Colorizes log entries based on the level.
Signature
export declare const getColoredShow: (show: Show<LogEntry>) => Show<LogEntry>
Added in v0.1.2
info
Log an ‘INFO’ message.
Signature
export declare const info: (message: string) => ReaderIO<LoggerEnv, void>
Added in v0.1.0
infoP
Log an ‘INFO’ message with a payload.
Signature
export declare const infoP: (message: string) => (payload: JsonRecord) => ReaderIO<LoggerEnv, void>
Added in v0.2.0
warn
Log a ‘WARN’ message.
Signature
export declare const warn: (message: string) => ReaderIO<LoggerEnv, void>
Added in v0.1.0
warnP
Log a ‘WARN’ message with a payload.
Signature
export declare const warnP: (message: string) => (payload: JsonRecord) => ReaderIO<LoggerEnv, void>
Added in v0.2.0
model
LogEntry (interface)
Signature
export interface LogEntry {
readonly message: string
readonly date: Date
readonly level: LogLevel
readonly payload: JsonRecord
}
Added in v0.1.0
LogLevel (type alias)
Signature
export type LogLevel = 'DEBUG' | 'INFO' | 'WARN' | 'ERROR'
Added in v0.1.0
Logger (type alias)
Signature
export type Logger = LoggerIO<LogEntry>
Added in v0.1.0
LoggerEnv (interface)
Signature
export interface LoggerEnv extends ClockEnv {
readonly logger: Logger
}
Added in v0.1.0