A refernce to the AWS CloudFormation library.
Helpful methods for interacting with RStreams' DynamoDB tables.
A refernce to the AWS S3 library.
A library allowing one to manually create, update, checkpoint or retrieve information on a bot.
Creates a pipeline step that will checkpoint and then pass the events on to the next step in the pipeline.
When to checkpoint.
The pipeline step that is ready to be used in a pipeline
This is a callback-based version of the RStreamsSdk.enrichEvents function.
It reads events from one queue and writes them to another queue. Put another way,
an enrich operation reads events from a source inQueue and then writes them to a destination outQueue,
allowing for side effects or transformation in the process.
The EnrichOptions.transform function
is called when events are retrieved from the source queue so you can transform them and send them to the
destination queue by calling the callback in the transform function. The callback here as the second argument
of this function is meant to be called when all enriching is done on all events (right before it closes down the stream),
allowing you to do clean up like closing a DB connection or something.
The type of the data event retrieved from the source queue
The type of the data event that is sent to the destination queue
TThe details of how to enrich and the function that does the work to enrich
A function called when all events have been processed
This is an async/await friendly version of the RStreamsSdk.enrich function.
It reads events from one queue and writes them to another queue. Put another way,
an enrich operation reads events from a source inQueue and then writes them to a destination outQueue,
allowing for side effects or transformation in the process.
The EnrichOptions.transform function
is called when events are retrieved from the source queue so you can transform them and send them to the
destination queue by calling the callback in the transform function. The callback here as the second argument
of this function is meant to be called when all enriching is done on all events (right before it closes down the stream),
allowing you to do clean up like closing a DB connection or something.
The type of the event read from the source queue
The type of the event that will be written to the destination queue
The details of how to enrich and the function that does the work to enrich
This creates a pipeline step that acts as the last step of the pipeline, the sink, writing events sent to the pipeline step to the queue specified.
The type of the data received by the pipeline step
The bot to act as when writing, events will be marked as written by this bot
The queue into which events will be written
An object that contains config values that control the flow of events to outQueue
This is a callback-based version of RStreamsSdk.offloadEvents.
It reads events from a queue to do general processing (such as write to an external DB). It's called offload because it is commonly used to process events and offload them to external resources such as ElasticSearch or other databases that are off of the RStreams Bus.
It reads from the queue specified in opts and then calls the opts.transform function passing in the
events retrieved so they may be processed.
The type of the data read from the RStreams bus queue
This is an async/await friendly version of RStreamsSdk.offload.
It reads events from a queue to do general processing (such as write to an external DB). It's called offload because it is commonly used to process events and offload them to external resources such as ElasticSearch or other databases that are off of the RStreams Bus.
A callback-based function to write a single event to an RStreams queue. There are occasions where this is useful, perhaps inside a pipeline step.
The data to write as the payload of the event
The name of the bot to write the event as
The name of the queue to write to
The data to write to the queue
The function to call when done
An async/await friendly function to write a single event to a queue. There are occasions where this is useful, perhaps inside a pipeline step.
The data to write as the payload of the event
The name of the bot to write the event as
The name of the queue to write to
The payload of the event to write
Create a pipeline step that reads from the RStreams bus instance queue inQueue doing so
as bot botId.
The type of data that will be read from the queue.
The bot to read as
The queue to read from
The options on how to read from this queue
The pipeline step that is ready to be used in a pipeline
Create a pipeline step that takes the events from the previous pipeline step and then writes them to an RStreams bus queeu.
The bot to act as when writing.
Options for writing
The pipeline step that is ready to be used in a pipeline
Generated using TypeDoc
The main entry point for the RStreams Node SDK. It exposes commonly used functionality in the SDK. Many of these functions come from
StreamUtilwhich also includes more advanced capabilities.