Interface CreatePrettyMessageOptions

Options for nest-like formatting

interface CreatePrettyMessageOptions {
    action?: string;
    appName: string;
    childError?: DestructuredError;
    context: Record<string, unknown>;
    deep?: number;
    errorKey?: string;
    level: LogLevel;
    message: string;
    parentPath?: string;
    scope?: string;
    stack?: string;
    statusCode?: string;
    timestamp: string;
}

Properties

action? appName childError? context deep? errorKey? level message parentPath? scope? stack? statusCode? timestamp

Properties

Optionalaction

action?: string

Action where the message was logged

Example

'createOutput'

appName

appName: string

Application name

Example

'Jetstream'

OptionalchildError

childError?: DestructuredError

Child error. Print it recursively

context

context: Record<string, unknown>

Message context (additional data)

Example

{ id: 'xxx' }

Optionaldeep

deep?: number

Recursion depth

Example

0

OptionalerrorKey

errorKey?: string

Error key from ErrorKeys enum

Example

'NST_SA_EMAIL_NOT_UNIQUE'

level

level: LogLevel

Log level (info, error, warn, debug, verbose, log)

Example

'info'

message

message: string

Message text

Example

'Failed to create cloudlfare output'

OptionalparentPath

parentPath?: string

Parent path for child errors

Example

'MainService.start --> VideoService.createOutput'

Optionalscope

scope?: string

Scope where the message was logged

Example

'VideoService'

Optionalstack

stack?: string

Error stack from Error object (Error.stack)

OptionalstatusCode

statusCode?: string

HTTP status code

Example

'400'

timestamp

timestamp: string

Timestamp in ISO 8601 format

Example

'2021-06-10T16:33:42.000Z'

Settings

Member Visibility

On This Page

Properties