ChainGraph

Appearance

ChainGraph API Documentation / @badaitech/chaingraph-types / BooleanPort

Class: BooleanPort ​

Defined in: packages/chaingraph-types/src/port/instances/BooleanPort.ts:32

Concrete implementation of a Boolean Port.

This class extends BasePort using BooleanPortConfig and BooleanPortValue. It leverages BooleanPortPlugin for validation, serialization, deserialization, and for determining the default value if one is provided in the configuration.

Example usage: const config: BooleanPortConfig = { type: 'boolean', defaultValue: true, }

const booleanPort = new BooleanPort(config) booleanPort.setValue({ type: 'boolean', value: false }) console.log(booleanPort.getValue()) // => { type: 'boolean', value: false }

Extends ​

Implements ​

Constructors ​

Constructor ​

new BooleanPort(config): BooleanPort

Defined in: packages/chaingraph-types/src/port/instances/BooleanPort.ts:35

Parameters ​

config ​

BooleanPortConfig

Returns ​

BooleanPort

Overrides ​

BasePort.constructor

Properties ​

config ​

protected config: BooleanPortConfig

Defined in: packages/chaingraph-types/src/port/base/BasePort.ts:16

Inherited from ​

BasePort.config

value? ​

protected optional value: boolean

Defined in: packages/chaingraph-types/src/port/base/BasePort.ts:17

Inherited from ​

BasePort.value

Accessors ​

id ​

Get Signature ​

get id(): string

Defined in: packages/chaingraph-types/src/port/base/BasePort.ts:25

The unique identifier of the port.

Returns ​

string

Implementation of ​

IPort.id

Inherited from ​

BasePort.id

key ​

Get Signature ​

get key(): string

Defined in: packages/chaingraph-types/src/port/base/BasePort.ts:29

The key of the port.

Returns ​

string

Implementation of ​

IPort.key

Inherited from ​

BasePort.key

Methods ​

addConnection() ​

addConnection(nodeId, portId): void

Defined in: packages/chaingraph-types/src/port/base/BasePort.ts:153

Adds a connection to the port metadata.

Parameters ​

nodeId ​

string

The ID of the node to connect to.

portId ​

string

The ID of the port to connect to.

Returns ​

void

Implementation of ​

IPort.addConnection

Inherited from ​

BasePort.addConnection

clone() ​

clone(): IPort<BooleanPortConfig>

Defined in: packages/chaingraph-types/src/port/base/BasePort.ts:130

Clones the port instance.

Returns ​

IPort<BooleanPortConfig>

A new port instance with the same configuration and value.

Implementation of ​

IPort.clone

Inherited from ​

BasePort.clone

cloneWithNewId() ​

cloneWithNewId(): IPort<BooleanPortConfig>

Defined in: packages/chaingraph-types/src/port/instances/BooleanPort.ts:128

Clones the port with a new ID. Useful for creating copies of the port with a unique identifier.

Returns ​

IPort<BooleanPortConfig>

Implementation of ​

IPort.cloneWithNewId

Overrides ​

BasePort.cloneWithNewId

deserialize() ​

deserialize(data): IPort<BooleanPortConfig>

Defined in: packages/chaingraph-types/src/port/base/BasePort.ts:79

Deserializes the given JSONValue (expected to hold { config, value }) and updates both the config and current value.

Parameters ​

data ​

unknown

Returns ​

IPort<BooleanPortConfig>

Implementation of ​

IPort.deserialize

Inherited from ​

BasePort.deserialize

deserializeConfig() ​

deserializeConfig(data): BooleanPortConfig

Defined in: packages/chaingraph-types/src/port/instances/BooleanPort.ts:109

Deserializes the provided JSON data into a boolean port configuration. Delegates deserialization logic to the BooleanPortPlugin.

Parameters ​

data ​

unknown

The JSON data representing the configuration.

Returns ​

BooleanPortConfig

The deserialized BooleanPortConfig.

Implementation of ​

IPort.deserializeConfig

Overrides ​

BasePort.deserializeConfig

deserializeValue() ​

deserializeValue(data): boolean

Defined in: packages/chaingraph-types/src/port/instances/BooleanPort.ts:120

Deserializes the given JSON data into a boolean port value. Delegates this task to the BooleanPortPlugin.

Parameters ​

data ​

unknown

The JSON data representing the value.

Returns ​

boolean

The deserialized BooleanPortValue.

Implementation of ​

IPort.deserializeValue

Overrides ​

BasePort.deserializeValue

getConfig() ​

getConfig(): BooleanPortConfig

Defined in: packages/chaingraph-types/src/port/base/BasePort.ts:33

Retrieves the current port configuration.

Returns ​

BooleanPortConfig

The port configuration of type C.

Implementation of ​

IPort.getConfig

Inherited from ​

BasePort.getConfig

getDefaultValue() ​

getDefaultValue(): boolean | undefined

Defined in: packages/chaingraph-types/src/port/instances/BooleanPort.ts:52

Retrieves the default value from the configuration. If a defaultValue is provided in the config, it returns that; otherwise, it returns undefined.

Returns ​

boolean | undefined

The default BooleanPortValue if provided; otherwise undefined.

Implementation of ​

IPort.getDefaultValue

Overrides ​

BasePort.getDefaultValue

getValue() ​

getValue(): boolean | undefined

Defined in: packages/chaingraph-types/src/port/base/BasePort.ts:42

Gets the current port value.

Returns ​

boolean | undefined

The port value, or undefined if none is set.

Implementation of ​

IPort.getValue

Inherited from ​

BasePort.getValue

isSystem() ​

isSystem(): boolean

Defined in: packages/chaingraph-types/src/port/base/BasePort.ts:138

Check if the port is a system port.

Returns ​

boolean

True if the port is a system port, otherwise false.

Implementation of ​

IPort.isSystem

Inherited from ​

BasePort.isSystem

isSystemError() ​

isSystemError(): boolean

Defined in: packages/chaingraph-types/src/port/base/BasePort.ts:142

Check if the port is a system error port.

Returns ​

boolean

True if the port is a system error port, otherwise false.

Implementation of ​

IPort.isSystemError

Inherited from ​

BasePort.isSystemError

removeConnection() ​

removeConnection(nodeId, portId): void

Defined in: packages/chaingraph-types/src/port/base/BasePort.ts:179

Removes a connection from the port metadata.

Parameters ​

nodeId ​

string

The ID of the node to disconnect from.

portId ​

string

The ID of the port to disconnect from.

Returns ​

void

Implementation of ​

IPort.removeConnection

Inherited from ​

BasePort.removeConnection

reset() ​

reset(): void

Defined in: packages/chaingraph-types/src/port/base/BasePort.ts:50

Resets the port’s current value.

In typical implementations, this resets the value to a default (if available).

Returns ​

void

Implementation of ​

IPort.reset

Inherited from ​

BasePort.reset

serialize() ​

serialize(): unknown

Defined in: packages/chaingraph-types/src/port/base/BasePort.ts:59

Serializes both config and value into a JSONValue–compatible object. It calls the abstract serializeConfig and serializeValue methods.

Returns ​

unknown

Implementation of ​

IPort.serialize

Inherited from ​

BasePort.serialize

serializeConfig() ​

serializeConfig(config): unknown

Defined in: packages/chaingraph-types/src/port/instances/BooleanPort.ts:87

Serializes the boolean port configuration into a JSON-compatible object. Delegates serialization logic to the BooleanPortPlugin.

Parameters ​

config ​

BooleanPortConfig

The boolean port configuration to serialize.

Returns ​

unknown

The serialized configuration as a JSONValue.

Implementation of ​

IPort.serializeConfig

Overrides ​

BasePort.serializeConfig

serializeValue() ​

serializeValue(value): unknown

Defined in: packages/chaingraph-types/src/port/instances/BooleanPort.ts:98

Serializes the provided boolean port value into a JSON-compatible object. Delegates serialization logic to the BooleanPortPlugin.

Parameters ​

value ​

boolean

The boolean port value to serialize.

Returns ​

unknown

The serialized value as a JSONValue.

Implementation of ​

IPort.serializeValue

Overrides ​

BasePort.serializeValue

setConfig() ​

setConfig(newConfig): void

Defined in: packages/chaingraph-types/src/port/base/BasePort.ts:37

Updates the port configuration with a new configuration object.

Parameters ​

newConfig ​

BooleanPortConfig

New configuration of type C.

Returns ​

void

Implementation of ​

IPort.setConfig

Inherited from ​

BasePort.setConfig

setValue() ​

setValue(newValue): void

Defined in: packages/chaingraph-types/src/port/base/BasePort.ts:46

Sets or updates the port value. The value must be validated before being accepted.

Parameters ​

newValue ​

The new value to set for the port.

boolean | undefined

Returns ​

void

Implementation of ​

IPort.setValue

Inherited from ​

BasePort.setValue

unwrap() ​

unwrap(): IPort<BooleanPortConfig>

Defined in: packages/chaingraph-types/src/port/base/BasePort.ts:237

Unwrap to get underlying port instance For regular ports, returns this (already unwrapped)

Returns ​

IPort<BooleanPortConfig>

Implementation of ​

IPort.unwrap

Inherited from ​

BasePort.unwrap

validate() ​

validate(): boolean

Defined in: packages/chaingraph-types/src/port/base/BasePort.ts:118

Validates both the current configuration and value. It defers to the abstract validateConfig and validateValue methods.

Returns ​

boolean

Implementation of ​

IPort.validate

Inherited from ​

BasePort.validate

validateConfig() ​

validateConfig(config): boolean

Defined in: packages/chaingraph-types/src/port/instances/BooleanPort.ts:75

Validates the boolean port configuration. Uses the BooleanPortPlugin to perform the validation.

Parameters ​

config ​

BooleanPortConfig

The boolean port configuration to validate.

Returns ​

boolean

True if the configuration is valid; otherwise, false.

Implementation of ​

IPort.validateConfig

Overrides ​

BasePort.validateConfig

validateValue() ​

validateValue(value): boolean

Defined in: packages/chaingraph-types/src/port/instances/BooleanPort.ts:63

Validates the provided boolean port value against the current configuration. Delegates the validation to the BooleanPortPlugin.

Parameters ​

value ​

boolean

The boolean port value to validate.

Returns ​

boolean

True if the value is valid; false otherwise.

Implementation of ​

IPort.validateValue

Overrides ​

BasePort.validateValue

Licensed under BUSL-1.1

Copyright © 2025 BadLabs