Interface Outlet<Out>
Type Parameters
-
Out extends DataFrame
Hierarchy-Diagram
Legend
class
interface
Hierarchy
- Outlet
Implemented by
Methods
on
- on(name: "pull", listener: ((options?: PullOptions) => void | Promise<void>)): Outlet<Out>
-
Event when a data frame is pulled
Parameters
-
name: "pull"
receive
-
listener: ((options?: PullOptions) => void | Promise<void>)
Event callback
-
- (options?: PullOptions): void | Promise<void>
-
Parameters
-
Optionaloptions: PullOptions
Returns void | Promise<void>
-
-
Returns Outlet<Out>
-
push
- push(data: Out | Out[], options?: PushOptions): Promise<void>
-
Push data to the outlet
Returns
Push promise
Parameters
-
data: Out | Out[]
Data frame to push
-
Optionaloptions: PushOptionsPush options
Returns Promise<void>
-
Outlet of a node that supports push events and pull listening.