### Hierarchy

- LoggerConfigBuilder

## Index

### Properties

- DEFAULT
- DEFAULT_BACKEND
- DEFAULT_COLOR_LAYOUT
- DEFAULT_LANG
- DEFAULT_LOGS_DIR
- DEFAULT_LOG_DIR
- DEFAULT_LOG_FILE_BACKUPS
- DEFAULT_LOG_FILE_DIR
- DEFAULT_LOG_FILE_EXT
- DEFAULT_LOG_FILE_MAX_SIZE
- DEFAULT_LOG_LAYOUT
- DEFAULT_LOG_TYPE_CONSOLE
- DEFAULT_LOG_TYPE_FILE_SYNC
- DEFAULT_LOG_TYPE_PAT

### Methods

- addConsoleAppender
- addFileAppender
- buildFullLogFile
- getDefaultFileName
- getDefaultIConfigLogging
- getDefaultLogLevel

## Properties

### Static Readonly DEFAULT

DEFAULT: "default" = "default"

- Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:26

### Static Readonly DEFAULT_BACKEND

DEFAULT_BACKEND: "NONE" = "NONE"

- Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:24

### Static Readonly DEFAULT_COLOR_LAYOUT

DEFAULT_COLOR_LAYOUT: string = "%[" + LoggerConfigBuilder.DEFAULT_LOG_LAYOUT + "%]"

- Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:22

### Static Readonly DEFAULT_LANG

DEFAULT_LANG: "en" = "en"

- Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:18

### Static Readonly DEFAULT_LOGS_DIR

DEFAULT_LOGS_DIR: "logs" = "logs"

- Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:35

### Static Readonly DEFAULT_LOG_DIR

DEFAULT_LOG_DIR: "\" | "/" = path.posix.sep

- Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:30

deprecated

  Use `DEFAULT_LOGS_DIR` instead.

### Static Readonly DEFAULT_LOG_FILE_BACKUPS

DEFAULT_LOG_FILE_BACKUPS: 5 = 5

- Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:38

### Static Readonly DEFAULT_LOG_FILE_DIR

DEFAULT_LOG_FILE_DIR: string = "logs" + path.posix.sep

- Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:34

deprecated

  Use `DEFAULT_LOGS_DIR` instead.

### Static Readonly DEFAULT_LOG_FILE_EXT

DEFAULT_LOG_FILE_EXT: ".log" = ".log"

- Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:36

### Static Readonly DEFAULT_LOG_FILE_MAX_SIZE

DEFAULT_LOG_FILE_MAX_SIZE: 10000000 = 10000000

- Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:37

### Static Readonly DEFAULT_LOG_LAYOUT

DEFAULT_LOG_LAYOUT: "[%d{yyyy/MM/dd} %d{hh:mm:ss.SSS}] [%p] %m" = "[%d{yyyy/MM/dd} %d{hh:mm:ss.SSS}] [%p] %m"

- Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:21

### Static Readonly DEFAULT_LOG_TYPE_CONSOLE

DEFAULT_LOG_TYPE_CONSOLE: "console" = "console"

- Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:19

### Static Readonly DEFAULT_LOG_TYPE_FILE_SYNC

DEFAULT_LOG_TYPE_FILE_SYNC: "fileSync" = "fileSync"

- Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:23

### Static Readonly DEFAULT_LOG_TYPE_PAT

DEFAULT_LOG_TYPE_PAT: "pattern" = "pattern"

- Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:20

## Methods

### Static addConsoleAppender

- addConsoleAppender(config: IConfigLogging, key: string, categoryName?: string, logLevel?: string): IConfigLogging

- - Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:70

  Returns the constant values defined within the LoggerConfigBuilder for this config object

  #### Parameters

  - ##### config: IConfigLogging

  - ##### key: string

  - ##### Default value categoryName: string = key

  - ##### Optional logLevel: string

  #### Returns IConfigLogging

  - default object built

### Static addFileAppender

- addFileAppender(config: IConfigLogging, key: string, categoryName?: string, filename?: string, logLevel?: string): IConfigLogging

- - Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:89

  Returns the constant values defined within the LoggerConfigBuilder for this config object

  #### Parameters

  - ##### config: IConfigLogging

  - ##### key: string

  - ##### Default value categoryName: string = key

  - ##### Default value filename: string = LoggerConfigBuilder.buildFullLogFile(LoggerConfigBuilder.getDefaultFileName(key))

  - ##### Optional logLevel: string

  #### Returns IConfigLogging

  - default object built

### Static buildFullLogFile

- buildFullLogFile(name: string): string

- - Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:46

  Build a fully qualified directory to a log file - defaults to the users home directory - Imperative does NOT use this as the home is set by the CLI configuration document.

  #### Parameters

  - ##### name: string

    name of the file to append to fully qualified directory

  #### Returns string

### Static getDefaultFileName

- getDefaultFileName(name: string): string

- - Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:113

  Returns the log file name that will be used

  #### Parameters

  - ##### name: string

  #### Returns string

  - the default file name for the log file

### Static getDefaultIConfigLogging

- getDefaultIConfigLogging(): IConfigLogging

- - Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:54

  Returns the constant values defined within the LoggerConfigBuilder for this config object

  #### Returns IConfigLogging

  - default object built

### Static getDefaultLogLevel

- getDefaultLogLevel(): string

- - Defined in @zowe/imperative/src/logger/src/LoggerConfigBuilder.ts:121

  Returns the log level that will be used if not overridden

  #### Returns string

  - the default log level

Generated using TypeDoc