neuron-js

Appearance

@sebasoft/neuron-js

Defined in: abstracts/AbstractAction.ts:7

Represents the base interface for all elements within the rules engine. Elements are the building blocks of scripts, pulses, actions, conditions, and parameters.

Extends ​

Type Parameters ​

TOptions ​

TOptions extends ActionOptions = ActionOptions

The type of configuration options for this element.

Constructors ​

Constructor ​

new AbstractAction<TOptions>(id, type, rawParams, options, neuron): AbstractAction<TOptions>

Defined in: abstracts/AbstractAction.ts:15

Parameters ​

id ​

string

type ​

string

rawParams ​

ParameterInterface<any, any>[]

options ​

TOptions

neuron ​

Neuron

Returns ​

AbstractAction<TOptions>

Overrides ​

AbstractElement.constructor

Properties ​

id ​

readonly id: string

Defined in: abstracts/AbstractElement.ts:7

Unique identifier for the element instance.

Inherited from ​

AbstractElement.id

neuron ​

protected readonly neuron: Neuron

Defined in: abstracts/AbstractAction.ts:20

options ​

readonly options: TOptions

Defined in: abstracts/AbstractElement.ts:9

Configuration options specific to this element instance.

Inherited from ​

AbstractElement.options

params ​

readonly params: Map<string, { getValue: unknown; }>

Defined in: abstracts/AbstractAction.ts:10

rawParams ​

readonly rawParams: ParameterInterface<any, any>[]

Defined in: abstracts/AbstractAction.ts:18

type ​

readonly type: string

Defined in: abstracts/AbstractElement.ts:8

The registered type name of the element. This type is used by the Registry (Neuron) to look up the correct implementation.

Inherited from ​

AbstractElement.type

Methods ​

toJSON() ​

toJSON(): object

Defined in: abstracts/AbstractAction.ts:26

Returns ​

object

Overrides ​

AbstractElement.toJSON