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

Interface: SecretPortConfig<S>

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

Secret port configuration.

Extends

• BasePortConfig

Type Parameters

S

S extends SecretType = any

Properties

connections?

optional connections: Connection[]

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

Inherited from

BasePortConfig.connections

---

defaultValue

defaultValue: undefined

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

---

description?

optional description: string

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

Inherited from

BasePortConfig.description

---

direction?

optional direction: PortDirectionEnum

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

Inherited from

BasePortConfig.direction

---

id?

optional id: string

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

Inherited from

BasePortConfig.id

---

key?

optional key: string

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

Inherited from

BasePortConfig.key

---

metadata?

optional metadata: Record<string, unknown>

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

Inherited from

BasePortConfig.metadata

---

name?

optional name: string

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

Inherited from

BasePortConfig.name

---

nodeId?

optional nodeId: string

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

Inherited from

BasePortConfig.nodeId

---

order?

optional order: number

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

Inherited from

BasePortConfig.order

---

parentId?

optional parentId: string

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

Inherited from

BasePortConfig.parentId

---

required?

optional required: boolean

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

Inherited from

BasePortConfig.required

---

secretType

secretType: S

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

---

title?

optional title: string

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

Inherited from

BasePortConfig.title

---

type

type: "secret"

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

Overrides

BasePortConfig.type

---

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:197

Overrides

BasePortConfig.ui