Interface Inlet<In>
Type Parameters
-
In extends DataFrame
Hierarchy-Diagram
Legend
class
interface
Hierarchy
- Inlet
Implemented by
Methods
emit
- emit(name, arg): boolean
-
Emit unknown event
Parameters
-
name: string
completed
-
arg: any
Argument
Returns boolean
-
- emit(name, event): boolean
-
Emit completed event
Parameters
-
name: "completed"
completed
-
event: PushCompletedEvent
Returns boolean
-
- emit(name, event): boolean
-
Emit error
Parameters
-
name: "error"
error
-
event: PushError
Returns boolean
-
on
- on(name, listener): Inlet<In>
-
Event when a data frame is push to the node
Parameters
-
name: "push"
receive
-
listener: ((frame, options?) => void | Promise<void>)
Event callback
-
- (frame, options?): void | Promise<void>
-
Parameters
-
frame: In
-
Optionaloptions: PushOptions
Returns void | Promise<void>
-
-
Returns Inlet<In>
-
pull
- pull(options?): Promise<void>
-
Pull data from the inlet
Parameters
-
Optionaloptions: PullOptionsPull options
Returns Promise<void>
Pull promise
-
Inlet of a node that supports pulling and events.