Interface Outlet<Out>

Outlet of a node that supports push events and pull listening.

interface Outlet<Out> {
    get outletNode(): GraphNode<Out, any>;
    on(name, listener): this;
    push(data, options?): Promise<void> | PushPromise<void, any>;
}

Type Parameters

Out extends DataFrame

Implemented by

Edge

Index

Accessors

Methods

Accessors

outletNode

get outletNode(): GraphNode<Out, any>
Get the node of the outlet

Returns GraphNode<Out, any>
- Defined in src/graph/Outlet.ts:30

Methods

on

on(name, listener): this
Event when a data frame is pulled
Parameters
- name: "pull"
  receive
- listener: ((options?) => void | Promise<void> | PullPromise<void>)
  Event callback
  - - (options?): void | Promise<void> | PullPromise<void>
    - Parameters
      Optional options: PullOptions
      Returns void | Promise<void> | PullPromise<void>
Returns this
- Defined in src/graph/Outlet.ts:25

push

push(data, options?): Promise<void> | PushPromise<void, any>
Push data to the outlet
Parameters
- data: Out | Out[]
  Data frame to push
- Optional options: PushOptions
  Push options
Returns Promise<void> | PushPromise<void, any>
Push promise
- Defined in src/graph/Outlet.ts:18