Interface FirehoseOptions<Type, Data, CustomHeaders, CustomOptions>

interface FirehoseOptions<
    Type extends string = string,
    Data = any,
    CustomHeaders extends Record<string, any> = AnyHeaders,
    CustomOptions extends Record<string, any> = AnyOptions,
> {
    atLeastOne?: boolean;
    bufferSize?: number;
    logger?: LoggerInstance;
    maxInactivityTime?: number;
    postConsumeOptions?: PostConsumeOptions;
    retryOptions?: RetryOptions;
    sinks: Plugs.Sink.Any<Type, Data, CustomHeaders, CustomOptions>[];
    sources: Plugs.Source.Any<Type, Data, CustomHeaders, CustomOptions>[];
    strategies?: {
        [type: string]: Jobs.Strategy<Type, Data, CustomHeaders, CustomOptions>[];
    };
}

Type Parameters

  • Type extends string = string
  • Data = any
  • CustomHeaders extends Record<string, any> = AnyHeaders
  • CustomOptions extends Record<string, any> = AnyOptions

Properties

atLeastOne? bufferSize? logger? maxInactivityTime? postConsumeOptions? retryOptions? sinks sources strategies?

Properties

OptionalatLeastOne

atLeastOne?: boolean

Define the number of sinks that must confirm a job, default options is all of them

OptionalbufferSize

bufferSize?: number

Buffer sizes

Optionallogger

logger?: LoggerInstance

Logger instance for deep debugging tasks

OptionalmaxInactivityTime

maxInactivityTime?: number

Maximum time of inactivity before the firehose notify that is hold

OptionalpostConsumeOptions

postConsumeOptions?: PostConsumeOptions

Post consume operation options

OptionalretryOptions

retryOptions?: RetryOptions

Retry options for sink/source operations

sinks

sinks: Plugs.Sink.Any<Type, Data, CustomHeaders, CustomOptions>[]

Firehose sinks

sources

sources: Plugs.Source.Any<Type, Data, CustomHeaders, CustomOptions>[]

Firehose sources

Optionalstrategies

strategies?: {
    [type: string]: Jobs.Strategy<Type, Data, CustomHeaders, CustomOptions>[];
}

Firehose transformation strategies per job type

Settings

Member Visibility

On This Page

Properties