pipeline package
Classes
| Class | Description |
|---|---|
| DynamicExecutor | |
| EventEmitter | A simple implementation of an event emitter. The |
| Pipe | Represents a processing unit within a pipeline. It encapsulates a callback function and various options to control its behavior. |
| Pipeline | Represents a pipeline that consists of multiple pipes, offering methods to execute them sequentially, add or remove pipes, and serialize the pipeline configuration. |
| PipeRegistry |
Functions
| Function | Description |
|---|---|
| batchDecorator(fn, options) | |
| isRecordOfString(variable) | Determines if a variable is a plain object with string values. |
| mergeJSONSafely(obj1, obj2) | Merges two JSON objects safely by checking for key conflicts. If a key exists in both obj1 and obj2, it will throw an error. |
| replaceSlots(obj, replacements) | Replaces all slots in the given object with the provided replacements. If a slot matches a key in the replacements, it will be substituted. If the replacement value is an object, and the slot covers the entire string, the entire value will be replaced by the object. Otherwise, the object will be stringified. |
Interfaces
| Interface | Description |
|---|---|
| BatchOptions | |
| ExecutorConfig | |
| PipelineContext | Represents the context in which a pipeline operates. |
| PipelineOptions | Options for configuring a pipeline. |
| PipeOptions | Options for configuring a pipe. The |
| SerializablePipelineOptions | Represents serializable options for a pipeline. It extends PipelineOptions with an array of SerializablePipeOptions to represent individual pipe configurations. |
Type Aliases
| Type Alias | Description |
|---|---|
| Awaited_2 | |
| MaybePromise | Represents a value that can be either a direct value of type T or a Promise that resolves to type T. Useful for functions that might return a value synchronously or asynchronously. |
| PipeRegistryType | |
| Registry | |
| SerializablePipeOptions | Represents serializable options for a pipe. It's a type alias for the PipeOptions interface that does not constrain the types of its input or result, making it usable in contexts where generic type parameters might not be specified. |