Options
All
  • Public
  • Public/Protected
  • All
Menu

kafka-sagas

Index

Enumerations

Classes

Interfaces

Type aliases

Functions

Type aliases

ActionChannel

ActionChannel<Payload>: IActionChannelEffectDescription<IAction<Payload>>

Aliases

Type parameters

  • Payload

ActionChannelEffect

ActionChannelEffect<Payload>: (pattern: ActionChannelInput<IAction<Payload>>, actionBuffer?: IActionBuffer<IAction<Payload>>) => IActionChannelEffectDescription<IAction<Payload>>

Type parameters

  • Payload

Type declaration

ActionChannelInput

ActionChannelInput<Action>: string | string[] | IPredicateRecord<Action>

Type parameters

ActionObserver

ActionObserver<Action>: (action: Action) => void

Type parameters

Type declaration

    • (action: Action): void

    • Parameters

      • action: Action

      Returns void

AllCombinatorEffect

AllCombinatorEffect<Payload>: (effects: ICombinatatorEffectDescription<IAction<Payload>>["effects"]) => ICombinatatorEffectDescription<IAction<Payload>>

Type parameters

  • Payload

Type declaration

ArrayCombinator

ArrayCombinator<Action>: <Combined>(combined: Combined) => Promise<Action[]>

Type parameters

Type declaration

    • <Combined>(combined: Combined): Promise<Action[]>

    • Type parameters

      • Combined: Array<Promise<Action>>

      Parameters

      • combined: Combined

      Returns Promise<Action[]>

CallEffect

CallEffect<Fn>: (callable: (args: Parameters<Fn>) => ReturnType<Fn>, args?: Parameters<Fn>) => ICallEffectDescription<Parameters<Fn>, ReturnType<Fn>>

Type parameters

  • Fn: (...args: any[]) => any

Type declaration

    • (callable: (args: Parameters<Fn>) => ReturnType<Fn>, args?: Parameters<Fn>): ICallEffectDescription<Parameters<Fn>, ReturnType<Fn>>

    • Parameters

      • callable: (args: Parameters<Fn>) => ReturnType<Fn>
          • (args: Parameters<Fn>): ReturnType<Fn>

          • Parameters

            • args: Parameters<Fn>

            Returns ReturnType<Fn>

      • Optional args: Parameters<Fn>

      Returns ICallEffectDescription<Parameters<Fn>, ReturnType<Fn>>

CallableSaga

CallableSaga<InitialActionPayload, Context, Result>: (payload: InitialActionPayload, context: Context) => Generator<IEffectDescription, Result, any>

Type parameters

Type declaration

    • (payload: InitialActionPayload, context: Context): Generator<IEffectDescription, Result, any>

    • Parameters

      • payload: InitialActionPayload
      • context: Context

      Returns Generator<IEffectDescription, Result, any>

DefaultPayload

DefaultPayload: Record<string, any> | undefined

DelayEffect

DelayEffect<Payload>: (delayInMilliseconds: number, payload?: Payload) => IDelayEffectDescription<Payload>

Type parameters

  • Payload: {} | undefined = undefined

Type declaration

Middleware

Middleware<EffectDescription, Context, Response>: (next: Next<EffectDescription, Context>) => (effectDescription: EffectDescription, context: Context) => Promise<Response>

Type parameters

Type declaration

    • (next: Next<EffectDescription, Context>): (effectDescription: EffectDescription, context: Context) => Promise<Response>

    • Parameters

      • next: Next<EffectDescription, Context>

      Returns (effectDescription: EffectDescription, context: Context) => Promise<Response>

        • (effectDescription: EffectDescription, context: Context): Promise<Response>

        • Parameters

          • effectDescription: EffectDescription
          • context: Context

          Returns Promise<Response>

Next

Next<EffectDescription, Context, Response>: (effectDescription: EffectDescription, context: Context) => Promise<Response>

Type parameters

Type declaration

    • (effectDescription: EffectDescription, context: Context): Promise<Response>

    • Parameters

      • effectDescription: EffectDescription
      • context: Context

      Returns Promise<Response>

PromiseResolver

PromiseResolver<ResolvedValue>: (value?: ResolvedValue | PromiseLike<ResolvedValue> | undefined) => void

Type parameters

  • ResolvedValue

Type declaration

    • (value?: ResolvedValue | PromiseLike<ResolvedValue> | undefined): void

    • Parameters

      • Optional value: ResolvedValue | PromiseLike<ResolvedValue> | undefined

      Returns void

PutEffect

PutEffect<Payload>: (pattern: string, payload?: Payload) => IPutEffectDescription<Payload>

Effects

Type parameters

  • Payload

Type declaration

RaceCombinatorEffect

RaceCombinatorEffect<Payload>: (effects: ICombinatatorEffectDescription<IAction<Payload>>["effects"]) => ICombinatatorEffectDescription<IAction<Payload>>

Type parameters

  • Payload

Type declaration

RecordCombinator

RecordCombinator<Action>: <Combined>(combined: Combined) => Promise<Record<string, Action>>

Type parameters

Type declaration

    • <Combined>(combined: Combined): Promise<Record<string, Action>>

    • Type parameters

      • Combined: Record<string, Promise<Action>> = Record<string, Promise<Action>>

      Parameters

      • combined: Combined

      Returns Promise<Record<string, Action>>

Saga

Saga<InitialActionPayload, Context>: (initialAction: IAction<InitialActionPayload>, context: Context) => Generator<IEffectDescription, any, UnPromisify<ReturnType<SagaRunner<IEffectDescription, Context>["runEffect"]>>>

Saga

Type parameters

Type declaration

    • (initialAction: IAction<InitialActionPayload>, context: Context): Generator<IEffectDescription, any, UnPromisify<ReturnType<SagaRunner<IEffectDescription, Context>["runEffect"]>>>

    • Parameters

      • initialAction: IAction<InitialActionPayload>
      • context: Context

      Returns Generator<IEffectDescription, any, UnPromisify<ReturnType<SagaRunner<IEffectDescription, Context>["runEffect"]>>>

SagaConsumerConfig

SagaConsumerConfig: ConsumerConfig & { consumptionTimeoutMs: number }

SagaContext

SagaContext<Extension>: IBaseSagaContext & Extension

Type parameters

  • Extension = Record<string, any>

SagaProducerConfig

SagaProducerConfig: Omit<ProducerConfig, "maxInFlightRequests" | "idempotent"> & { flushIntervalMs: number; maxOutgoingBatchSize: number }

TakeEffect

TakeEffect<Payload>: (pattern: TakePattern) => ITakeEffectDescription<IAction<Payload>> | ITakeActionChannelEffectDescription<IAction<Payload>>

Type parameters

  • Payload

Type declaration

TakePattern

TakePattern<Action>: ActionChannelInput<Action> | IActionChannelEffectDescription<Action>

Type parameters

UnPromisify

UnPromisify<T>: T extends Promise<infer U> ? U : T

Utilities

Type parameters

  • T

Functions

actionPatternIsPredicateRecord

allPromise

  • allPromise(promises: Array<Promise<any>> | Record<string, Promise<any>>): Bluebird<Object>

createActionMessage

  • createActionMessage<Action>(__namedParameters: { action: Action }): Message

Const getLoggerFromConfig

  • getLoggerFromConfig<T>(config?: T): Logger

isActionChannelEffectDescription

  • isActionChannelEffectDescription(effectDescription: IEffectDescription): effectDescription is IActionChannelEffectDescription<any>

isCallEffectDescription

  • isCallEffectDescription(effectDescription: IEffectDescription): effectDescription is ICallEffectDescription<any[], any>

isDelayEffectDescription

  • isDelayEffectDescription<Payload>(effectDescription: IEffectDescription): effectDescription is IDelayEffectDescription<Payload>

isEffectCombinatorDescription

  • isEffectCombinatorDescription<Action>(effectDescription: IEffectDescription): effectDescription is ICombinatatorEffectDescription<Action>

isGenerator

  • isGenerator(possibleGenerator: any): possibleGenerator is Generator

  • Parameters

    • possibleGenerator: any

    Returns possibleGenerator is Generator

isKafkaJSProtocolError

  • isKafkaJSProtocolError(error: unknown): error is IKafkaJSProtocolError

isPutEffectDescription

  • isPutEffectDescription<Payload>(effectDescription: IEffectDescription): effectDescription is IPutEffectDescription<Payload>

isTakeActionChannelEffectDescription

  • isTakeActionChannelEffectDescription(effectDescription: IEffectDescription): effectDescription is IActionChannelEffectDescription<any>

isTakeEffectDescription

  • isTakeEffectDescription(effectDescription: IEffectDescription): effectDescription is ITakeEffectDescription

isTakePatternActuallyActionChannelEffectDescription

isTransactionMessage

  • isTransactionMessage<Payload>(messageValue: IAction | any): messageValue is Omit<IAction<Payload>, "topic">

  • Type parameters

    • Payload

    Parameters

    Returns messageValue is Omit<IAction<Payload>, "topic">

parseHeaders

  • parseHeaders(headers?: IHeaders): Record<keyof typeof headers, string | undefined>

  • Parameters

    • Optional headers: IHeaders

    Returns Record<keyof typeof headers, string | undefined>

racePromise

  • racePromise(raceable: Array<Promise<any>> | Record<string, Promise<any>>): Promise<any>

racePromiseRecord

  • racePromiseRecord<Keys>(raceable: Record<Keys, Promise<any>>): Promise<Record<Keys, any>>

takeInputIsActionChannelEffectDescription

takeInputIsActionPattern

transformKafkaMessageToAction

  • transformKafkaMessageToAction<Payload>(topic: string, message: KafkaMessage, headerParser?: (h: IHeaders | undefined) => Record<string, string>, valueParser?: (val: string) => any): IAction<Payload>

  • Type parameters

    • Payload

    Parameters

    • topic: string
    • message: KafkaMessage
    • Default value headerParser: (h: IHeaders | undefined) => Record<string, string> = parseHeaders
        • (h: IHeaders | undefined): Record<string, string>

        • Parameters

          • h: IHeaders | undefined

          Returns Record<string, string>

    • Default value valueParser: (val: string) => any = JSON.parse
        • (val: string): any

        • Parameters

          • val: string

          Returns any

    Returns IAction<Payload>

Generated using TypeDoc