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

Class: PortFactory

Defined in: packages/chaingraph-types/src/port/factory/PortFactory.ts:75

Constructors

Constructor

new PortFactory(): PortFactory

Returns

PortFactory

Methods

create()

static create<T>(config): PortInstanceFromConfig<T>

Defined in: packages/chaingraph-types/src/port/factory/PortFactory.ts:85

Creates a port instance given one of the supported configurations. (The return type is a union of all supported port instances.)

Note that because you are passing in a union type the compiler does not automatically narrow the result. Therefore, if you care about preserving full generic type information (for example, for object ports), use the specific convenience methods (for example, createObjectPort) below.

Type Parameters

T

T extends IPortConfig

Parameters

config

T

Returns

PortInstanceFromConfig<T>

---

createAnyPort()

static createAnyPort(config): AnyPort

Defined in: packages/chaingraph-types/src/port/factory/PortFactory.ts:265

Parameters

config

AnyPortConfig

Returns

AnyPort

---

createArrayPort()

static createArrayPort<I>(config): ArrayPort<I>

Defined in: packages/chaingraph-types/src/port/factory/PortFactory.ts:246

Type Parameters

I

I extends IPortConfig

Parameters

config

ArrayPortConfig<I>

Returns

ArrayPort<I>

---

createBooleanPort()

static createBooleanPort(config): BooleanPort

Defined in: packages/chaingraph-types/src/port/factory/PortFactory.ts:242

Parameters

config

BooleanPortConfig

Returns

BooleanPort

---

createEnumPort()

static createEnumPort(config): EnumPort

Defined in: packages/chaingraph-types/src/port/factory/PortFactory.ts:261

Parameters

config

EnumPortConfig

Returns

EnumPort

---

createFromConfig()

static createFromConfig(config): IPort

Defined in: packages/chaingraph-types/src/port/factory/PortFactory.ts:228

For dynamic or legacy code – create a port instance from an untyped configuration.

Parameters

config

IPortConfig

Returns

IPort

---

createNumberPort()

static createNumberPort(config): NumberPort

Defined in: packages/chaingraph-types/src/port/factory/PortFactory.ts:238

Parameters

config

NumberPortConfig

Returns

NumberPort

---

createObjectPort()

static createObjectPort<S>(config): ObjectPort<S>

Defined in: packages/chaingraph-types/src/port/factory/PortFactory.ts:253

Type Parameters

S

S extends IObjectSchema<Record<string, IPortConfig>>

Parameters

config

ObjectPortConfig<S>

Returns

ObjectPort<S>

---

createStreamPort()

static createStreamPort<I>(config): StreamPort<I>

Defined in: packages/chaingraph-types/src/port/factory/PortFactory.ts:257

Type Parameters

I

I extends IPortConfig

Parameters

config

StreamPortConfig<I>

Returns

StreamPort<I>

---

createStringPort()

static createStringPort(config): StringPort

Defined in: packages/chaingraph-types/src/port/factory/PortFactory.ts:234

Parameters

config

StringPortConfig

Returns

StringPort

---

deserializeConfig()

static deserializeConfig<T>(data): IPortConfig

Defined in: packages/chaingraph-types/src/port/factory/PortFactory.ts:129

Type Parameters

T

T extends unknown

Parameters

data

T

Returns

IPortConfig

---

deserializeValue()

static deserializeValue<T, V>(config, data): ExtractValue<T>

Defined in: packages/chaingraph-types/src/port/factory/PortFactory.ts:181

Type Parameters

T

T extends IPortConfig

V

V extends unknown

Parameters

config

T

data

V

Returns

ExtractValue<T>