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

Interface: BasePortConfig

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

Base interface for all port configurations

Complete port configs have all required fields including 'type'. Reference configs ($ref) are stored separately as IPortConfigReference.

Extended by

• StringPortConfig
• NumberPortConfig
• ArrayPortConfig
• SecretPortConfig
• ObjectPortConfig
• StreamPortConfig
• BooleanPortConfig
• EnumPortConfig
• AnyPortConfig

Properties

connections?

optional connections: Connection[]

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

---

description?

optional description: string

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

---

direction?

optional direction: PortDirectionEnum

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

---

id?

optional id: string

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

---

key?

optional key: string

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

---

metadata?

optional metadata: Record<string, unknown>

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

---

name?

optional name: string

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

---

nodeId?

optional nodeId: string

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

---

order?

optional order: number

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

---

parentId?

optional parentId: string

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

---

required?

optional required: boolean

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

---

title?

optional title: string

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

---

type

type: "string" | "number" | "boolean" | "object" | "array" | "stream" | "enum" | "secret" | "any"

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

---

ui?

optional ui: objectOutputType<{ bgColor: ZodOptional<ZodString>; borderColor: ZodOptional<ZodString>; disabled: ZodOptional<ZodBoolean>; hidden: ZodOptional<ZodBoolean>; hideEditor: ZodOptional<ZodBoolean>; hidePort: ZodOptional<ZodBoolean>; }, ZodTypeAny, "passthrough">

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