Options
All
  • Public
  • Public/Protected
  • All
Menu

Module index

Index

References

Re-exports BatchOptions
Re-exports BotInvocationEvent
Re-exports BotInvocationEvent2
Re-exports Checkpoint
Re-exports Checkpoints
Re-exports CommandWrapFunction
Re-exports CommandWrapOptions
Re-exports CorrelationId
Re-exports Cron
Re-exports DataCallback
Re-exports DuplexStream
Re-exports ErrorCallback
Re-exports Event
Re-exports FlushCallback
Re-exports FromCsvOptions
Re-exports ProcessCallback
Re-exports ProcessCallbackOptions
Re-exports ProcessFunction
Re-exports RStreamsContext
Re-exports RStreamsTransformFunction
Re-exports ReadEvent
Re-exports ReadableStream
Re-exports ToCsvOptions
Re-exports TransformFunction
Re-exports TransformStream
Re-exports WritableStream
Re-exports WriteEvent
Re-exports batch
Re-exports buffer
Re-exports bufferBackoff
Re-exports commandWrap
Re-exports counter
Re-exports devnull
Re-exports eventIdFromTimestamp
Re-exports eventIdToTimestamp
Re-exports fromCSV
Re-exports fromS3
Re-exports log
Re-exports parse
Re-exports passthrough
Re-exports pipe
Re-exports pipeAsync
Re-exports pipeline
Re-exports process
Re-exports stringify
Re-exports through
Re-exports throughAsync
Re-exports toCSV
Re-exports toS3
Re-exports writeWrapped

Type aliases

Callback: (err?: any, data?: any) => void

Type declaration

    • (err?: any, data?: any): void
    • A standard callback function. If the operation failed, return the first argument only, often a string or an Error object. If the operation succeeded and nothing needs to be returned from the callback, pass no arguments. If the operation succeeded and something needs to be returned through the callback, pass null as the first argument and the return object as the second argument.

      Parameters

      • Optional err: any

        If present, indicates the operation failed.

      • Optional data: any

        If present and err is not present, the return value from the operation.

      Returns void

ThroughEvent<T>: Event<T> | any

Defines an event used in through operations.

see

StreamUtil.through

Type parameters

  • T

    The payload of the event.

Functions

  • This returns a function that you call to create an instance of the RStreams SDK.

    Parameters

    • Optional config: ConfigurationResources | typeof default

      The SDK is usually smart enough to find the config it needs or you can pass it in directly here.

    Returns RStreamsSdk

    The SDK instance itself.

Generated using TypeDoc