RxEnvironments.jl

https://reactivebayes.github.io/RxEnvironments.jl/stable/

Admin

RxEnvironments.jl is a Julia package designed for creating and managing reactive environments,...

Tokens:480

Snippets:8

Trust Score:9.7

Update:3 months ago

Show doc for...

Tokens:

Raw

### Install RxEnvironments.jl

Source: https://reactivebayes.github.io/RxEnvironments.jl

Use the Julia package manager to install the library.

```julia
using Pkg
Pkg.add("RxEnvironments")
```

--------------------------------

### RxEnvironments.add!

Source: https://reactivebayes.github.io/RxEnvironments.jl

Adds an entity to an environment or another entity.

```APIDOC
## add!(environment, entity)

### Description
Adds a specified entity to the target environment or parent entity.

### Parameters
- **environment** (AbstractEntity) - The target environment or entity.
- **entity** (AbstractEntity) - The entity to be added.
```

--------------------------------

### RxEnvironments.create_entity

Source: https://reactivebayes.github.io/RxEnvironments.jl

Creates a new entity instance.

```APIDOC
## create_entity(type, args...)

### Description
Instantiates a new entity of the specified type.

### Parameters
- **type** (Type) - The type of entity to create.
- **args** (Any) - Arguments required for entity initialization.
```

--------------------------------

### RxEnvironments.terminate!

Source: https://reactivebayes.github.io/RxEnvironments.jl

Terminates an entity or environment.

```APIDOC
## terminate!(entity)

### Description
Stops and cleans up the specified entity.

### Parameters
- **entity** (AbstractEntity) - The entity to terminate.
```

--------------------------------

### RxEnvironments.send!

Source: https://reactivebayes.github.io/RxEnvironments.jl

Sends a message or action to an entity.

```APIDOC
## send!(entity, message)

### Description
Dispatches a message or action to the specified entity.

### Parameters
- **entity** (AbstractEntity) - The target entity.
- **message** (Any) - The data or action to send.
```

--------------------------------

### RxEnvironments.subscribe_to_observations!

Source: https://reactivebayes.github.io/RxEnvironments.jl

Subscribes to observations emitted by an entity.

```APIDOC
## subscribe_to_observations!(entity, handler)

### Description
Registers a handler to receive observations from the specified entity.

### Parameters
- **entity** (AbstractEntity) - The entity to observe.
- **handler** (Function) - The callback function to process observations.
```

Tokens:

Raw