Interface FileHandlerOptions

Represents the options for the SingleJsonlFileManager

interface FileHandlerOptions {
    archiveFolderPath: string;
    baseFilename: string;
    createFolders: boolean;
    defaultBaseFilename?: string;
    fileEncoding: BufferEncoding;
    inactiveTimeout?: number;
    logger?: LoggerInstance;
    propertyData?: string;
    propertyFileName?: string;
    propertySkip?: string;
    propertySkipValue?: string | number | boolean;
    retryOptions?: RetryOptions;
    rotationInterval?: number;
    rotationLines?: number;
    rotationSize?: number;
    separator?: string;
    workingFolderPath: string;
}

Hierarchy (View Summary)

Properties

archiveFolderPath baseFilename createFolders defaultBaseFilename? fileEncoding inactiveTimeout? logger? propertyData? propertyFileName? propertySkip? propertySkipValue? retryOptions? rotationInterval? rotationLines? rotationSize? separator? workingFolderPath

Properties

archiveFolderPath

archiveFolderPath: string

Path to the folder where the closed files are stored

Example

'./data/archive'

Default Value

'./data/archive'

baseFilename

baseFilename: string

Base filename for the files

createFolders

createFolders: boolean

If true, it will create the folders if they don't exist

Example

true

Default Value

true

OptionaldefaultBaseFilename

defaultBaseFilename?: string

Base filename for the files

Example

'file'

Default Value

'file'

fileEncoding

fileEncoding: BufferEncoding

Encoding to use when writing to files

Example

'utf-8'

OptionalinactiveTimeout

inactiveTimeout?: number

Maximum inactivity time in milliseconds before a handler is cleaned up

Example

60000

Default Value

undefined

Optionallogger

logger?: LoggerInstance

Logger instance to use

Default Value

undefined

OptionalpropertyData

propertyData?: string

If set, this property will be used to store the data in the file, it could be a nested property in the data object expressed as a dot separated string

Example

'data.property'

Default Value

undefined

OptionalpropertyFileName

propertyFileName?: string

If set, this property will be used as the filename, it could be a nested property in the data object expressed as a dot separated string

Example

'data.property'

Default Value

undefined

OptionalpropertySkip

propertySkip?: string

If set, this property will be used to skip the data, it could be a nested property in the data object expressed as a dot separated string

Example

'data.property'

Default Value

undefined

OptionalpropertySkipValue

propertySkipValue?: string | number | boolean

If set, this value will be used to skip the data, it could be a string, number or boolean. If value is not set, but propertySkip is set, a not falsy value will be used to skip the data, this means that any value that is not false, 0 or '' will be used to skip the data.

Example

'skip' | 0 | false

Default Value

undefined

OptionalretryOptions

retryOptions?: RetryOptions

Retry options for the file handler operations

Example

{ attempts: 3, timeout: 1000, waitTime: 1000, maxWaitTime: 10000 }

Default Value

{ attempts: 3, timeout: 1000, waitTime: 1000, maxWaitTime: 10000 }

OptionalrotationInterval

rotationInterval?: number

Interval in milliseconds to rotate the file

Example

3600000 (1 hour)

Default Value

undefined

OptionalrotationLines

rotationLines?: number

Max number of lines before rotating the file

Example

10000 (10k lines)

Default Value

undefined

OptionalrotationSize

rotationSize?: number

Max size of the file before rotating it

Example

10485760 (10 MB)

Default Value

undefined

Optionalseparator

separator?: string

Separator to use when writing the data to the file

Example

'\n'

Default Value

'\n'

workingFolderPath

workingFolderPath: string

Path to the folder where the working files are stored

Example

'./data/working'

Default Value

'./data/working'

Settings

Member Visibility

On This Page

Properties