Class Logger

Interface that allows you to log records. This records are treated by handlers

Index

Constructors

constructor

new Logger(key: string, displayName?: string): Logger
Create a new Logger
Parameters
- key: string
- OptionaldisplayName: string
Returns Logger
- Defined in packages/nightingale-logger/src/index.ts:122

Properties

`Optional` `Readonly`displayName

displayName?: string

`Readonly`key

key: string

Methods

addRecord

addRecord<T extends Metadata>(record: Readonly<LogRecord<T>>): void
Handle a record

Use this only if you know what you are doing.
Type Parameters
- T extends Metadata
Parameters
- record: Readonly<LogRecord<T>>
Returns void
- Defined in packages/nightingale-logger/src/index.ts:208

alert

alert<T extends Metadata>(
    messageOrError: string | Error,
    metadata?: T,
    metadataStyles?: MetadataStyles<T>,
): void
Log an alert message
Type Parameters
- T extends Metadata
Parameters
- messageOrError: string | Error
- Optionalmetadata: T
- OptionalmetadataStyles: MetadataStyles<T>
Returns void
- Defined in packages/nightingale-logger/src/index.ts:383

child

child(childSuffixKey: string, childDisplayName?: string): Logger
Create a child logger
Parameters
- childSuffixKey: string
- OptionalchildDisplayName: string
Returns Logger
- Defined in packages/nightingale-logger/src/index.ts:148

context

context(context: Record<string, unknown>): Logger

Create a new Logger with the same key a this attached context

Parameters

context: Record<string, unknown>

Returns Logger

Example

const loggerMyService = new Logger('app:myService');
function someAction(arg1) {
    const logger = loggerMyService.context({ arg1 });
    logger.enter(someAction);
    // do stuff
    logger.info('info');
    // do stuff
    logger.exit(someAction);
}

critical

critical<T extends Metadata>(
    messageOrError: string | Error,
    metadata?: T,
    metadataStyles?: MetadataStyles<T>,
): void
Log an critical message
Type Parameters
- T extends Metadata
Parameters
- messageOrError: string | Error
- Optionalmetadata: T
- OptionalmetadataStyles: MetadataStyles<T>
Returns void
- Defined in packages/nightingale-logger/src/index.ts:351

debug

debug<T extends Metadata>(
    messageOrError: string | Error,
    metadata?: T,
    metadataStyles?: MetadataStyles<T>,
): void
Log a debug message
Type Parameters
- T extends Metadata
Parameters
- messageOrError: string | Error
- Optionalmetadata: T
- OptionalmetadataStyles: MetadataStyles<T>
Returns void
- Defined in packages/nightingale-logger/src/index.ts:286

debugFail

debugFail<T extends Metadata>(
    messageOrError: string | Error,
    metadata?: T,
    metadataStyles?: MetadataStyles<T>,
): void
Log an debug fail message
Type Parameters
- T extends Metadata
Parameters
- messageOrError: string | Error
- Optionalmetadata: T
- OptionalmetadataStyles: MetadataStyles<T>
Returns void
- Defined in packages/nightingale-logger/src/index.ts:502

debugSuccess

debugSuccess<T extends Metadata>(
    message: string,
    metadata?: T,
    metadataStyles?: MetadataStyles<T>,
): void
Log an debug success message
Type Parameters
- T extends Metadata
Parameters
- message: string
- Optionalmetadata: T
- OptionalmetadataStyles: MetadataStyles<T>
Returns void
- Defined in packages/nightingale-logger/src/index.ts:461

enter

enter<T extends Metadata, Fn extends (...args: unknown[]) => unknown>(
    fn: Fn,
    metadata?: T,
    metadataStyles?: MetadataStyles<ExtendedFunctionNameMetadata & T>,
): void
Log an enter in a function
Type Parameters
- T extends Metadata
- Fn extends (...args: unknown[]) => unknown
Parameters
- fn: Fn
- Optionalmetadata: T
- OptionalmetadataStyles: MetadataStyles<ExtendedFunctionNameMetadata & T>
Returns void
Example
```
class A {
  method(arg1) {
    logger.enter(method, { arg1 });
    // Do your stuff
  }
}
```
- Defined in packages/nightingale-logger/src/index.ts:615

error

error<T extends Metadata>(
    messageOrError: string | Error,
    metadata?: T,
    metadataStyles?: MetadataStyles<T>,
): void
Log an error message
Type Parameters
- T extends Metadata
Parameters
- messageOrError: string | Error
- Optionalmetadata: T
- OptionalmetadataStyles: MetadataStyles<T>
Returns void
Example
```
const logger = new Logger('something');
try {
  throw new Error('Always throws here');
} catch (error) {
  logger.error('caught error', { error });
}
```
- Defined in packages/nightingale-logger/src/index.ts:340

exit

exit<T extends Metadata, Fn extends (...args: unknown[]) => unknown>(
    fn: Fn,
    metadata?: T,
    metadataStyles?: MetadataStyles<ExtendedFunctionNameMetadata & T>,
): void
Log an exit in a function
Type Parameters
- T extends Metadata
- Fn extends (...args: unknown[]) => unknown
Parameters
- fn: Fn
- Optionalmetadata: T
- OptionalmetadataStyles: MetadataStyles<ExtendedFunctionNameMetadata & T>
Returns void
Example
```
const logger = new Logger('myNamespace:A');
class A {
  method(arg1) {
    // Do your stuff
    logger.exit(method, { arg1 });
  }
}
```
- Defined in packages/nightingale-logger/src/index.ts:641

extendsContext

extendsContext(extendedContext: Record<string, unknown>): void
Extends existing context of this logger
Parameters
- extendedContext: Record<string, unknown>
Returns void
- Defined in packages/nightingale-logger/src/index.ts:194

fail

fail<T extends Metadata>(
    messageOrError: string | Error,
    metadata?: T,
    metadataStyles?: MetadataStyles<T>,
): void
Alias for infoFail
Type Parameters
- T extends Metadata
Parameters
- messageOrError: string | Error
- Optionalmetadata: T
- OptionalmetadataStyles: MetadataStyles<T>
Returns void
- Defined in packages/nightingale-logger/src/index.ts:476

fatal

fatal<T extends Metadata>(
    messageOrError: string | Error,
    metadata?: T,
    metadataStyles?: MetadataStyles<T>,
): void
Log a fatal message
Type Parameters
- T extends Metadata
Parameters
- messageOrError: string | Error
- Optionalmetadata: T
- OptionalmetadataStyles: MetadataStyles<T>
Returns void
Example
```
const logger = new Logger('something');
try {
  throw new Error('Always throws here');
} catch (error) {
  logger.error('caught error', { error });
  process.exit(1);
```
- Defined in packages/nightingale-logger/src/index.ts:372

getContextObject

getContextObject(): undefined | Readonly<Record<string, unknown>>
Get the context of this logger

Returns undefined | Readonly<Record<string, unknown>>
- Defined in packages/nightingale-logger/src/index.ts:178

info

info<T extends Metadata>(
    messageOrError: string | Error,
    metadata?: T,
    metadataStyles?: MetadataStyles<T>,
): void
Log an info message
Type Parameters
- T extends Metadata
Parameters
- messageOrError: string | Error
- Optionalmetadata: T
- OptionalmetadataStyles: MetadataStyles<T>
Returns void
- Defined in packages/nightingale-logger/src/index.ts:308

infoFail

infoFail<T extends Metadata>(
    messageOrError: string | Error,
    metadata?: T,
    metadataStyles?: MetadataStyles<T>,
): void
Log an info fail message
Type Parameters
- T extends Metadata
Parameters
- messageOrError: string | Error
- Optionalmetadata: T
- OptionalmetadataStyles: MetadataStyles<T>
Returns void
- Defined in packages/nightingale-logger/src/index.ts:487

infoSuccess

infoSuccess<T extends Metadata>(
    message: string,
    metadata?: T,
    metadataStyles?: MetadataStyles<T>,
): void
Log an info success message
Type Parameters
- T extends Metadata
Parameters
- message: string
- Optionalmetadata: T
- OptionalmetadataStyles: MetadataStyles<T>
Returns void
- Defined in packages/nightingale-logger/src/index.ts:446

infoSuccessTimeEnd

infoSuccessTimeEnd<T extends Metadata>(
    time: number,
    message: string,
    metadata?: T,
    metadataStyles?: MetadataStyles<T>,
): void
Like timeEnd, but with INFO level
Type Parameters
- T extends Metadata
Parameters
- time: number
- message: string
- Optionalmetadata: T
- OptionalmetadataStyles: MetadataStyles<T>
Returns void
- Defined in packages/nightingale-logger/src/index.ts:589

infoTime

infoTime<T extends Metadata>(
    message?: string,
    metadata?: T,
    metadataStyles?: MetadataStyles<T>,
): number
Type Parameters
- T extends Metadata
Parameters
- Optionalmessage: string
- Optionalmetadata: T
- OptionalmetadataStyles: MetadataStyles<T>
Returns number
- Defined in packages/nightingale-logger/src/index.ts:530

infoTimeEnd

infoTimeEnd<T extends Metadata>(
    time: number,
    message: string,
    metadata?: T,
    metadataStyles?: MetadataStyles<T>,
): void
Like timeEnd, but with INFO level
Type Parameters
- T extends Metadata
Parameters
- time: number
- message: string
- Optionalmetadata: T
- OptionalmetadataStyles: MetadataStyles<T>
Returns void
- Defined in packages/nightingale-logger/src/index.ts:577

inspectValue

inspectValue<T extends Metadata>(
    value: unknown,
    metadata?: T,
    metadataStyles?: MetadataStyles<T>,
): void
Log an inspected value
Type Parameters
- T extends Metadata
Parameters
- value: unknown
- Optionalmetadata: T
- OptionalmetadataStyles: MetadataStyles<T>
Returns void
- Defined in packages/nightingale-logger/src/index.ts:394

inspectVar

inspectVar<T extends Metadata>(
    varName: string,
    varValue: unknown,
    metadata?: T,
    metadataStyles?: MetadataStyles<T>,
): void
Log a debugged var
Type Parameters
- T extends Metadata
Parameters
- varName: string
- varValue: unknown
- Optionalmetadata: T
- OptionalmetadataStyles: MetadataStyles<T>
Returns void
- Defined in packages/nightingale-logger/src/index.ts:415

log

log<T extends Metadata>(
    messageOrError: string | Error,
    metadata?: T,
    level?: Level,
    options?: Options<T>,
): void
Log a message
Type Parameters
- T extends Metadata
Parameters
- messageOrError: string | Error
- Optionalmetadata: T
- level: Level = Level.INFO
- Optionaloptions: Options<T>
Returns void
- Defined in packages/nightingale-logger/src/index.ts:236

notice

notice<T extends Metadata>(
    messageOrError: string | Error,
    metadata?: T,
    metadataStyles?: MetadataStyles<T>,
): void
Notice an info message
Type Parameters
- T extends Metadata
Parameters
- messageOrError: string | Error
- Optionalmetadata: T
- OptionalmetadataStyles: MetadataStyles<T>
Returns void
- Defined in packages/nightingale-logger/src/index.ts:297

setContext

setContext(context: Record<string, unknown>): void
Set the context of this logger
Parameters
- context: Record<string, unknown>
Returns void
- Defined in packages/nightingale-logger/src/index.ts:187

success

success<T extends Metadata>(
    message: string,
    metadata?: T,
    metadataStyles?: MetadataStyles<T>,
): void
Alias for infoSuccess
Type Parameters
- T extends Metadata
Parameters
- message: string
- Optionalmetadata: T
- OptionalmetadataStyles: MetadataStyles<T>
Returns void
- Defined in packages/nightingale-logger/src/index.ts:435

time

time<T extends Metadata>(
    message?: string,
    metadata?: T,
    metadataStyles?: MetadataStyles<T>,
    level?: number,
): number
Type Parameters
- T extends Metadata
Parameters
- Optionalmessage: string
- Optionalmetadata: T
- OptionalmetadataStyles: MetadataStyles<T>
- level: number = Level.DEBUG
Returns number
time to pass to timeEnd
- Defined in packages/nightingale-logger/src/index.ts:517

timeEnd

timeEnd<T extends Metadata>(
    startTime: number,
    message: string,
    metadata?: T,
    metadataStyles?: MetadataStyles<T>,
    level?: number,
    options?: Options<T>,
): void
Finds difference between when this method was called and when the respective time method was called, then logs out the difference and deletes the original record
Type Parameters
- T extends Metadata
Parameters
- startTime: number
- message: string
- Optionalmetadata: T
- OptionalmetadataStyles: MetadataStyles<T>
- level: number = Level.DEBUG
- Optionaloptions: Options<T>
Returns void
- Defined in packages/nightingale-logger/src/index.ts:544

trace

trace<T extends Metadata>(
    messageOrError: string | Error,
    metadata?: T,
    metadataStyles?: MetadataStyles<T>,
): void
Log a trace message
Type Parameters
- T extends Metadata
Parameters
- messageOrError: string | Error
- Optionalmetadata: T
- OptionalmetadataStyles: MetadataStyles<T>
Returns void
- Defined in packages/nightingale-logger/src/index.ts:275

warn

warn<T extends Metadata>(
    messageOrError: string | Error,
    metadata?: T,
    metadataStyles?: MetadataStyles<T>,
): void
Log a warn message
Type Parameters
- T extends Metadata
Parameters
- messageOrError: string | Error
- Optionalmetadata: T
- OptionalmetadataStyles: MetadataStyles<T>
Returns void
- Defined in packages/nightingale-logger/src/index.ts:319

wrap

wrap<Fn extends (...args: unknown[]) => unknown>(
fn: Fn,
callback: () => void,
): void
Wrap around a function to log enter and exit of a function
Type Parameters
- Fn extends (...args: unknown[]) => unknown
Parameters
- fn: Fn
- callback: () => void
Returns void
Example
```
const logger = new Logger('myNamespace:A');
class A {
  method() {
    logger.wrap(method, () => {
      // Do your stuff
    });
  }
}
```
- Defined in packages/nightingale-logger/src/index.ts:668
wrap<T extends Metadata, Fn extends (...args: unknown[]) => unknown>(
    fn: Fn,
    metadata: T,
    callback: () => void,
): void
Wrap around a function to log enter and exit of a function
Type Parameters
- T extends Metadata
- Fn extends (...args: unknown[]) => unknown
Parameters
- fn: Fn
- metadata: T
- callback: () => void
Returns void
Example
```
const logger = new Logger('myNamespace:A');
class A {
  method() {
    logger.wrap(method, () => {
      // Do your stuff
    });
  }
}
```
- Defined in packages/nightingale-logger/src/index.ts:673
wrap<T extends Metadata, Fn extends (...args: unknown[]) => unknown>(
    fn: Fn,
    metadata: T,
    metadataStyles: MetadataStyles<T>,
    callback: () => void,
): void
Wrap around a function to log enter and exit of a function
Type Parameters
- T extends Metadata
- Fn extends (...args: unknown[]) => unknown
Parameters
- fn: Fn
- metadata: T
- metadataStyles: MetadataStyles<T>
- callback: () => void
Returns void
Example
```
const logger = new Logger('myNamespace:A');
class A {
  method() {
    logger.wrap(method, () => {
      // Do your stuff
    });
  }
}
```
- Defined in packages/nightingale-logger/src/index.ts:679

Class Logger

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Logger

Properties

Optional ReadonlydisplayName

Readonlykey

Methods

addRecord

Type Parameters

Parameters

Returns void

alert

Type Parameters

Parameters

Returns void

child

Parameters

Returns Logger

context

Parameters

Returns Logger

Example

critical

Type Parameters

Parameters

Returns void

debug

Type Parameters

Parameters

Returns void

debugFail

Type Parameters

Parameters

Returns void

debugSuccess

Type Parameters

Parameters

Returns void

enter

Type Parameters

Parameters

Returns void

Example

error

Type Parameters

Parameters

Returns void

Example

exit

Type Parameters

Parameters

Returns void

Example

extendsContext

Parameters

Returns void

fail

Type Parameters

Parameters

Returns void

fatal

Type Parameters

Parameters

Returns void

Example

getContextObject

Returns undefined | Readonly<Record<string, unknown>>

info

Type Parameters

Parameters

Returns void

infoFail

Type Parameters

Parameters

`Optional` `Readonly`displayName

`Readonly`key