Skip to content

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

Function: PortBoolean()

PortBoolean(config?): PropertyDecorator

Defined in: packages/chaingraph-types/src/decorator/scalar.decorator.ts:84

Boolean decorator to specify a port configuration for type "boolean". This decorator automatically sets the port type to "boolean". Additional configuration options (like defaultValue, etc.) can be provided.

Usage examples:

// Using default configuration: @PortBoolean() public myFlag: boolean = false;

// With custom configuration: @PortBoolean({ defaultValue: true }) public myFlag?: boolean;

Parameters

config?

Omit<BooleanPortConfig, "type">

Optional configuration object for boolean-specific options.

Returns

PropertyDecorator

Licensed under BUSL-1.1