neuron-js

Appearance

@sebasoft/neuron-js

Defined in: plugins/parameters/ComparatorParameter.ts:7

Represents a configurable input value for Actions and Conditions. Parameters allow for reusable logic templates by decoupling the implementation from the values.

Extends ​

Constructors ​

Constructor ​

new ComparatorParameter(id, type, name, value, options, defaultValue?): ComparatorParameter

Defined in: abstracts/AbstractParameter.ts:10

Parameters ​

id ​

string

type ​

string

name ​

string

value ​

Comparator | null

options ​

any

defaultValue? ​

Comparator

Returns ​

ComparatorParameter

Inherited from ​

AbstractParameter.constructor

Properties ​

defaultValue? ​

readonly optional defaultValue?: Comparator

Defined in: abstracts/AbstractParameter.ts:16

An optional fallback value if the primary value is missing or null.

Inherited from ​

AbstractParameter.defaultValue

id ​

readonly id: string

Defined in: abstracts/AbstractElement.ts:7

Unique identifier for the element instance.

Inherited from ​

AbstractParameter.id

name ​

readonly name: string

Defined in: abstracts/AbstractParameter.ts:13

The semantic name of the parameter (e.g., "recipient", "threshold").

Inherited from ​

AbstractParameter.name

options ​

readonly options: any

Defined in: abstracts/AbstractElement.ts:9

Configuration options specific to this element instance.

Inherited from ​

AbstractParameter.options

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 ​

AbstractParameter.type

value ​

value: Comparator | null

Defined in: abstracts/AbstractParameter.ts:14

The actual value assigned to the parameter.

Inherited from ​

AbstractParameter.value

TYPE ​

readonly static TYPE: "comparator" = "comparator"

Defined in: plugins/parameters/ComparatorParameter.ts:8

Methods ​

execute() ​

execute(context): ExecutionResult<Comparator | null>

Defined in: abstracts/AbstractParameter.ts:23

Parameters ​

context ​

ExecutionContext

Returns ​

ExecutionResult<Comparator | null>

Inherited from ​

AbstractParameter.execute

getValue() ​

getValue(_context): Comparator | null

Defined in: plugins/parameters/ComparatorParameter.ts:10

Parameters ​

_context ​

ExecutionContext

Returns ​

Comparator | null

Overrides ​

AbstractParameter.getValue

toJSON() ​

toJSON(): object

Defined in: abstracts/AbstractParameter.ts:34

Returns ​

object

Inherited from ​

AbstractParameter.toJSON