@hlang-org/runtime
A FBP-Inspired language for universal applications. Version 1.0.7, 6 exports.
Classes
Flow
Defined in: packages/runtime/src/base/flow.ts:21
Constructors
Constructor
new Flow(opts?): Flow;Defined in: packages/runtime/src/base/flow.ts:25
Parameters
| Parameter | Type |
|---|---|
opts? | { } |
Returns
Properties
| Property | Type | Defined in |
|---|---|---|
cache | Map<string, any> | packages/runtime/src/base/flow.ts:23 |
opts | object | packages/runtime/src/base/flow.ts:22 |
Methods
run()
run(rootNode): void;Defined in: packages/runtime/src/base/flow.ts:30
Parameters
| Parameter | Type |
|---|---|
rootNode | any |
Returns
void
Node
Defined in: packages/runtime/src/node/node.ts:45
Extended by
Constructors
Constructor
new Node(opts): Node;Defined in: packages/runtime/src/node/node.ts:56
Parameters
| Parameter | Type |
|---|---|
opts | any |
Returns
Properties
| Property | Type | Defined in |
|---|---|---|
flow | Flow | null | packages/runtime/src/node/node.ts:51 |
I | (name) => Port | packages/runtime/src/node/node.ts:53 |
id | string | packages/runtime/src/node/node.ts:47 |
identity | Symbol | packages/runtime/src/node/node.ts:52 |
isRunning | boolean | packages/runtime/src/node/node.ts:50 |
O | (name) => Port | packages/runtime/src/node/node.ts:54 |
opts | object | packages/runtime/src/node/node.ts:48 |
portMap | PortMap | packages/runtime/src/node/node.ts:49 |
type | Symbol | packages/runtime/src/node/node.ts:46 |
Methods
attach()
attach(flow): void;Defined in: packages/runtime/src/node/node.ts:85
Parameters
| Parameter | Type |
|---|---|
flow | any |
Returns
void
attachPort()
attachPort(port): void;Defined in: packages/runtime/src/node/node.ts:89
Parameters
| Parameter | Type |
|---|---|
port | any |
Returns
void
E()
E(): Port;Defined in: packages/runtime/src/node/node.ts:81
Returns
executeOnce()
executeOnce(type, ...args): void;Defined in: packages/runtime/src/node/node.ts:73
Parameters
| Parameter | Type |
|---|---|
type | any |
...args | any[] |
Returns
void
Port
Defined in: packages/runtime/src/base/port.ts:7
Constructors
Constructor
new Port(__namedParameters): Port;Defined in: packages/runtime/src/base/port.ts:20
Parameters
| Parameter | Type |
|---|---|
__namedParameters | { name?: string; type: any; } |
__namedParameters.name? | string |
__namedParameters.type | any |
Returns
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
$eventEmitter | public | Subject<any> | packages/runtime/src/base/port.ts:18 |
$pipedEventEmitter | public | any | packages/runtime/src/base/port.ts:17 |
id | public | string | packages/runtime/src/base/port.ts:8 |
identity | public | symbol | packages/runtime/src/base/port.ts:14 |
isActive | public | boolean | packages/runtime/src/base/port.ts:13 |
name | public | string | packages/runtime/src/base/port.ts:9 |
node | public | Node | null | packages/runtime/src/base/port.ts:12 |
peers | public | Port[] | packages/runtime/src/base/port.ts:11 |
type | public | string | packages/runtime/src/base/port.ts:10 |
I | static | (name) => Port | packages/runtime/src/base/port.ts:15 |
O | static | (name) => Port | packages/runtime/src/base/port.ts:16 |
Accessors
$
Get Signature
get $(): any;Defined in: packages/runtime/src/base/port.ts:51
Returns
any
Methods
active()
active(): void;Defined in: packages/runtime/src/base/port.ts:29
Returns
void
addPeer()
addPeer(val): void;Defined in: packages/runtime/src/base/port.ts:37
Parameters
| Parameter | Type |
|---|---|
val | Port |
Returns
void
attach()
attach(node): void;Defined in: packages/runtime/src/base/port.ts:41
Parameters
| Parameter | Type |
|---|---|
node | Node |
Returns
void
connect()
connect(port): Port;Defined in: packages/runtime/src/base/port.ts:94
Parameters
| Parameter | Type |
|---|---|
port | any |
Returns
deActive()
deActive(): void;Defined in: packages/runtime/src/base/port.ts:33
Returns
void
on()
on(next): any;Defined in: packages/runtime/src/base/port.ts:79
Parameters
| Parameter | Type |
|---|---|
next | any |
Returns
any
pipe()
pipe(...args): object;Defined in: packages/runtime/src/base/port.ts:62
Parameters
| Parameter | Type |
|---|---|
...args | any[] |
Returns
object
| Name | Type | Defined in |
|---|---|---|
receive() | (next) => any | packages/runtime/src/base/port.ts:74 |
receive()
receive(next): any;Defined in: packages/runtime/src/base/port.ts:86
Parameters
| Parameter | Type |
|---|---|
next | any |
Returns
any
send()
send(msg): void;Defined in: packages/runtime/src/base/port.ts:55
Parameters
| Parameter | Type |
|---|---|
msg | any |
Returns
void
ReadableNode
Defined in: packages/runtime/src/node/readable.ts:5
Extends
Constructors
Constructor
new ReadableNode(opt): ReadableNode;Defined in: packages/runtime/src/node/readable.ts:6
Parameters
| Parameter | Type |
|---|---|
opt | any |
Returns
Overrides
Properties
| Property | Type | Inherited from | Defined in |
|---|---|---|---|
flow | Flow | null | Node.flow | packages/runtime/src/node/node.ts:51 |
I | (name) => Port | Node.I | packages/runtime/src/node/node.ts:53 |
id | string | Node.id | packages/runtime/src/node/node.ts:47 |
identity | Symbol | Node.identity | packages/runtime/src/node/node.ts:52 |
isRunning | boolean | Node.isRunning | packages/runtime/src/node/node.ts:50 |
O | (name) => Port | Node.O | packages/runtime/src/node/node.ts:54 |
opts | object | Node.opts | packages/runtime/src/node/node.ts:48 |
portMap | PortMap | Node.portMap | packages/runtime/src/node/node.ts:49 |
type | Symbol | Node.type | packages/runtime/src/node/node.ts:46 |
Methods
_read()
_read(_$o): void;Defined in: packages/runtime/src/node/readable.ts:17
Parameters
| Parameter | Type |
|---|---|
_$o | any |
Returns
void
attach()
attach(flow): void;Defined in: packages/runtime/src/node/node.ts:85
Parameters
| Parameter | Type |
|---|---|
flow | any |
Returns
void
Inherited from
attachPort()
attachPort(port): void;Defined in: packages/runtime/src/node/node.ts:89
Parameters
| Parameter | Type |
|---|---|
port | any |
Returns
void
Inherited from
E()
E(): Port;Defined in: packages/runtime/src/node/node.ts:81
Returns
Inherited from
executeOnce()
executeOnce(type, ...args): void;Defined in: packages/runtime/src/node/node.ts:73
Parameters
| Parameter | Type |
|---|---|
type | any |
...args | any[] |
Returns
void
Inherited from
throw()
throw(error): void;Defined in: packages/runtime/src/node/readable.ts:13
Parameters
| Parameter | Type |
|---|---|
error | any |
Returns
void
TransformNode
Defined in: packages/runtime/src/node/transform.ts:5
Extends
Constructors
Constructor
new TransformNode(opt): TransformNode;Defined in: packages/runtime/src/node/transform.ts:6
Parameters
| Parameter | Type |
|---|---|
opt | any |
Returns
Overrides
Properties
| Property | Type | Inherited from | Defined in |
|---|---|---|---|
flow | Flow | null | Node.flow | packages/runtime/src/node/node.ts:51 |
I | (name) => Port | Node.I | packages/runtime/src/node/node.ts:53 |
id | string | Node.id | packages/runtime/src/node/node.ts:47 |
identity | Symbol | Node.identity | packages/runtime/src/node/node.ts:52 |
isRunning | boolean | Node.isRunning | packages/runtime/src/node/node.ts:50 |
O | (name) => Port | Node.O | packages/runtime/src/node/node.ts:54 |
opts | object | Node.opts | packages/runtime/src/node/node.ts:48 |
portMap | PortMap | Node.portMap | packages/runtime/src/node/node.ts:49 |
type | Symbol | Node.type | packages/runtime/src/node/node.ts:46 |
Methods
_transform()
_transform(_$i, _$o): void;Defined in: packages/runtime/src/node/transform.ts:17
Parameters
| Parameter | Type |
|---|---|
_$i | any |
_$o | any |
Returns
void
attach()
attach(flow): void;Defined in: packages/runtime/src/node/node.ts:85
Parameters
| Parameter | Type |
|---|---|
flow | any |
Returns
void
Inherited from
attachPort()
attachPort(port): void;Defined in: packages/runtime/src/node/node.ts:89
Parameters
| Parameter | Type |
|---|---|
port | any |
Returns
void
Inherited from
E()
E(): Port;Defined in: packages/runtime/src/node/node.ts:81
Returns
Inherited from
executeOnce()
executeOnce(type, ...args): void;Defined in: packages/runtime/src/node/node.ts:73
Parameters
| Parameter | Type |
|---|---|
type | any |
...args | any[] |
Returns
void
Inherited from
throw()
throw(error): void;Defined in: packages/runtime/src/node/transform.ts:13
Parameters
| Parameter | Type |
|---|---|
error | any |
Returns
void
WriteableNode
Defined in: packages/runtime/src/node/writeable.ts:4
Extends
Constructors
Constructor
new WriteableNode(opt): WriteableNode;Defined in: packages/runtime/src/node/writeable.ts:5
Parameters
| Parameter | Type |
|---|---|
opt | any |
Returns
Overrides
Properties
| Property | Type | Inherited from | Defined in |
|---|---|---|---|
flow | Flow | null | Node.flow | packages/runtime/src/node/node.ts:51 |
I | (name) => Port | Node.I | packages/runtime/src/node/node.ts:53 |
id | string | Node.id | packages/runtime/src/node/node.ts:47 |
identity | Symbol | Node.identity | packages/runtime/src/node/node.ts:52 |
isRunning | boolean | Node.isRunning | packages/runtime/src/node/node.ts:50 |
O | (name) => Port | Node.O | packages/runtime/src/node/node.ts:54 |
opts | object | Node.opts | packages/runtime/src/node/node.ts:48 |
portMap | PortMap | Node.portMap | packages/runtime/src/node/node.ts:49 |
type | Symbol | Node.type | packages/runtime/src/node/node.ts:46 |
Methods
_write()
_write(_$i): void;Defined in: packages/runtime/src/node/writeable.ts:10
Parameters
| Parameter | Type |
|---|---|
_$i | any |
Returns
void
attach()
attach(flow): void;Defined in: packages/runtime/src/node/node.ts:85
Parameters
| Parameter | Type |
|---|---|
flow | any |
Returns
void
Inherited from
attachPort()
attachPort(port): void;Defined in: packages/runtime/src/node/node.ts:89
Parameters
| Parameter | Type |
|---|---|
port | any |
Returns
void
Inherited from
E()
E(): Port;Defined in: packages/runtime/src/node/node.ts:81
Returns
Inherited from
executeOnce()
executeOnce(type, ...args): void;Defined in: packages/runtime/src/node/node.ts:73
Parameters
| Parameter | Type |
|---|---|
type | any |
...args | any[] |
Returns
void
Inherited from
Generated by TypeDoc from packages/runtime/src at build time.