ChainGraph API Documentation / @badaitech/chaingraph-types / PortPluginRegistry
Class: PortPluginRegistry
Defined in: packages/chaingraph-types/src/port/plugins/PortPluginRegistry.ts:40
Registry for port plugins
Constructors
Constructor
new PortPluginRegistry():
PortPluginRegistry
Returns
PortPluginRegistry
Methods
clear()
clear():
void
Defined in: packages/chaingraph-types/src/port/plugins/PortPluginRegistry.ts:114
Clear all registered plugins (for testing)
Returns
void
cloneConfig()
cloneConfig<
T>(config):object[T]
Defined in: packages/chaingraph-types/src/port/plugins/PortPluginRegistry.ts:227
Type Parameters
T
T extends "string" | "number" | "boolean" | "object" | "array" | "stream" | "enum" | "secret" | "any"
Parameters
config
object[T]
Returns
object[T]
deserializeConfig()
deserializeConfig<
T>(type,data):object[T]
Defined in: packages/chaingraph-types/src/port/plugins/PortPluginRegistry.ts:242
Deserialize a port configuration
Type Parameters
T
T extends "string" | "number" | "boolean" | "object" | "array" | "stream" | "enum" | "secret" | "any"
Parameters
type
T
data
unknown
Returns
object[T]
deserializeValue()
deserializeValue<
T>(type,data,config):object[T]
Defined in: packages/chaingraph-types/src/port/plugins/PortPluginRegistry.ts:202
Deserialize a port value
Type Parameters
T
T extends "string" | "number" | "boolean" | "object" | "array" | "stream" | "enum" | "secret" | "any"
Parameters
type
T
data
unknown
config
object[T]
Returns
object[T]
getAllPlugins()
getAllPlugins():
IPortPlugin<any>[]
Defined in: packages/chaingraph-types/src/port/plugins/PortPluginRegistry.ts:93
Get all registered plugins
Returns
IPortPlugin<any>[]
getConfigUnionSchema()
getConfigUnionSchema():
ZodType<IPortConfig>
Defined in: packages/chaingraph-types/src/port/plugins/PortPluginRegistry.ts:121
Get a union schema for all registered config types
Returns
ZodType<IPortConfig>
getPlugin()
getPlugin<
T>(type):IPortPlugin<T> |undefined
Defined in: packages/chaingraph-types/src/port/plugins/PortPluginRegistry.ts:74
Get a plugin for a specific port type
Type Parameters
T
T extends "string" | "number" | "boolean" | "object" | "array" | "stream" | "enum" | "secret" | "any"
Parameters
type
T
Returns
IPortPlugin<T> | undefined
getValueUnionSchema()
getValueUnionSchema():
ZodType<any>
Defined in: packages/chaingraph-types/src/port/plugins/PortPluginRegistry.ts:133
Get a union schema for all registered value types
Returns
ZodType<any>
register()
register<
T>(plugin):void
Defined in: packages/chaingraph-types/src/port/plugins/PortPluginRegistry.ts:57
Register a plugin for a specific port type
Type Parameters
T
T extends "string" | "number" | "boolean" | "object" | "array" | "stream" | "enum" | "secret" | "any"
Parameters
plugin
IPortPlugin<T>
Returns
void
serializeConfig()
serializeConfig<
T>(config):unknown
Defined in: packages/chaingraph-types/src/port/plugins/PortPluginRegistry.ts:216
Serialize a port configuration
Type Parameters
T
T extends "string" | "number" | "boolean" | "object" | "array" | "stream" | "enum" | "secret" | "any"
Parameters
config
object[T]
Returns
unknown
serializeValue()
serializeValue<
T>(value,config):unknown
Defined in: packages/chaingraph-types/src/port/plugins/PortPluginRegistry.ts:188
Serialize a port value
Type Parameters
T
T extends "string" | "number" | "boolean" | "object" | "array" | "stream" | "enum" | "secret" | "any"
Parameters
value
object[T]
config
object[T]
Returns
unknown
validateConfig()
validateConfig(
config):IPortConfig
Defined in: packages/chaingraph-types/src/port/plugins/PortPluginRegistry.ts:158
Validate a port configuration
Parameters
config
unknown
Returns
validateValue()
validateValue(
value):any
Defined in: packages/chaingraph-types/src/port/plugins/PortPluginRegistry.ts:173
Validate a port value
Parameters
value
unknown
Returns
any
getInstance()
staticgetInstance():PortPluginRegistry
Defined in: packages/chaingraph-types/src/port/plugins/PortPluginRegistry.ts:47
Returns
PortPluginRegistry