Skip to content

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

Interface: IPortPlugin<T>

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

Interface for port plugins with specific type

Type Parameters

T

T extends PortType

Properties

configSchema

configSchema: ZodType<object[T]>

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


deserializeConfig()

deserializeConfig: (data) => object[T]

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

Parameters

data

unknown

Returns

object[T]


deserializeValue()

deserializeValue: (data, config) => object[T]

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

Parameters

data

unknown

config

object[T]

Returns

object[T]


serializeConfig()

serializeConfig: (config) => unknown

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

Parameters

config

object[T]

Returns

unknown


serializeValue()

serializeValue: (value, config) => unknown

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

Parameters

value

object[T]

config

object[T]

Returns

unknown


typeIdentifier

typeIdentifier: T

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


validateConfig()

validateConfig: (config) => string[]

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

Parameters

config

object[T]

Returns

string[]


validateValue()

validateValue: (value, config) => string[]

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

Parameters

value

object[T]

config

object[T]

Returns

string[]


valueSchema

valueSchema: ZodType<object[T]>

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

Licensed under BUSL-1.1