Interface FileFlingerOptions

Copyright 2024 Mytra Control S.L. All rights reserved.

Use of this source code is governed by an MIT-style license that can be found in the LICENSE file or at https://opensource.org/licenses/MIT.

interface FileFlingerOptions {
    archiveFolder?: string;
    cwd?: string;
    deadLetterFolder?: string;
    defaultValues?: Record<string, string>;
    errorStrategy?: ErrorStrategy;
    failedOperationDelay?: number;
    filePattern?: string;
    keyPattern?: string;
    logger?: LoggerInstance;
    maxErrors?: number;
    postProcessingStrategy?: PostProcessingStrategy;
    pushers: Pusher[];
    retryOptions?: RetryOptions;
    watchPath?: string | string[];
}

Hierarchy (View Summary)

Properties

archiveFolder? cwd? deadLetterFolder? defaultValues? errorStrategy? failedOperationDelay? filePattern? keyPattern? logger? maxErrors? postProcessingStrategy? pushers retryOptions? watchPath?

Properties

OptionalarchiveFolder

archiveFolder?: string

Archive folder for processed files

Optionalcwd

cwd?: string

The base path to use

OptionaldeadLetterFolder

deadLetterFolder?: string

Dead-letter folder for files with keying errors

OptionaldefaultValues

defaultValues?: Record<string, string>

The default values for the keys

OptionalerrorStrategy

errorStrategy?: ErrorStrategy

Determine the error strategy for files with errors

OptionalfailedOperationDelay

failedOperationDelay?: number

Delay between retries failed file processing operations

OptionalfilePattern

filePattern?: string

File pattern to match the files to process

OptionalkeyPattern

keyPattern?: string

Key pattern used to generate the key for the file in the pusher. The key pattern can contain placeholders that will be replaced by the actual values. The placeholders are enclosed in curly braces and the following are supported:

  • {_filename}: The name of the file
  • {_extension}: The extension of the file
  • {_timestamp}: The timestamp when the file was created or modified in milliseconds
  • {_date}: The date when the file was created or modified in the format YYYY-MM-DD
  • {_time}: The time when the file was created or modified in the format HH-mm-ss
  • {_datetime}: The date and time when the file was created or modified in the format YYYY-MM-DD_HH-mm-ss
  • {_year}: The year when the file was created or modified
  • {_month}: The month when the file was created or modified
  • {_day}: The day when the file was created or modified
  • {_hour}: The hour when the file was created or modified
  • {_minute}: The minute when the file was created or modified
  • {_second}: The second when the file was created or modified

Optionallogger

logger?: LoggerInstance

Logger instance for deep debugging tasks

OptionalmaxErrors

maxErrors?: number

Max number of errors to store

OptionalpostProcessingStrategy

postProcessingStrategy?: PostProcessingStrategy

Determine the post-processing strategy for files without errors

pushers

pushers: Pusher[]

Pushers to send the files to

OptionalretryOptions

retryOptions?: RetryOptions

Retry options for file operations

OptionalwatchPath

watchPath?: string | string[]

The path to watch

Settings

Member Visibility

On This Page

Properties