- Preparing search index...
- The search index is not available
A refernce to the AWS CloudFormation library.
Helpful methods for interacting with RStreams' DynamoDB tables.
A refernce to the AWS Firehose library.
A refernce to the AWS Kinesis library.
A refernce to the AWS S3 library.
A library allowing one to manually create, update, checkpoint or retrieve information on a bot.
Config used to communicate with AWS resources that comprise the RStreams Bus used by the SDK. It is included here for information purposes and so you can access the AWS resources that the SDK discovered and is using.
This is only to be used internally by the SDK. It used to be necessary externally and so remains for backward comaptibiliy.
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
A stream generated from a function that returns and array of data of type T
Allows for custom state to be kept and passed to the function generating new data
The data emitted from the stream
The current state of the source stream
Function that produces records to flow down stream
The current custom state of the source stream
A Stream of data type T
This is a callback-based version of the RStreamsSdk.enrichEvents function and should no longer be used.
Callback-based API flavors will be phased out over time.
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
The details of how to enrich and the function that does the work to enrich, either the batched or not batched version. The batched version will batch up requests to your transform function and pass it an array instead of a single object.
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, either the batched or not batched version. The batched version will batch up requests to your transform function and pass it an array instead of a single object.
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
For events that don't specify the bot to act as, this default is used. It is the bot to act as when writing, events will be marked as written by this bot. If not provided, each event must include the id of the bot to write the event as.
For events that don't specify the queue to write to, this default is used. It is the queue into which events will be written. If not provided, each event must include the queue to write the event to.
An object that contains config values that control the flow of events to outQueue
This is a callback-based version of the RStreamsSdk.offloadEvents function and should no longer be used.
Callback-based API flavors will be phased out over time.
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.
This is a callback-based version of the RStreamsSdk.putEvent function and should no longer be used.
Callback-based API flavors will be phased out over time.
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
This creates an async/await-friendly pipeline step that will take data in, possibly transform the data or do computation, and then sends the result on to the next step in the pipeline.
The type of the data sent in to be passed through this step.
The type of data to be sent on to the next step in the pipeline.
A function that does the work of taking the data in, doing something with it and then rejecting or resolving
the promise with the result object type U. If you resolve with no result data, the event is skipped and not sent to the next pipeline step.
The first arg is stripped off by Javascript since it recognizes that the this arg is just to set the this context
so that the this keyword will work inside the function and itself be the instance of the transform stream which can be useful.
For example, say you want to push to an event in here to a queue. You could do that by calling
this.push to push the event to a queue while still sending the queue on the next step in the pipeline afterwards.
So, the first real argument your function will receive is obj which is the data event being sent in to be processed/transformed
and sent on to the next pipeline step.
A function to be called when the entire pipeline has been flushed to allow for cleanup, perhaps closing a DB connection.
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 queue.
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.