Skip to content

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

Variable: Strategies

const Strategies: object

Defined in: packages/chaingraph-types/src/port/transfer-rules/strategies.ts:21

Library of reusable transfer strategies

Type Declaration

arrayConfigAndValue()

arrayConfigAndValue: (ctx) => Promise<TransferResult>

Transfer array configuration and value

Parameters

ctx

TransferContext

Returns

Promise<TransferResult>

arrayItemConfig()

arrayItemConfig: (ctx) => TransferResult

Transfer array item configuration

Parameters

ctx

TransferContext

Returns

TransferResult

arraySchemaReset()

arraySchemaReset: (ctx) => Promise<TransferResult>

Parameters

ctx

TransferContext

Returns

Promise<TransferResult>

compose()

compose: (...strategies) => TransferStrategy

Compose multiple strategies sequentially

Parameters

strategies

...TransferStrategy[]

Returns

TransferStrategy

noop()

noop: () => TransferResult

No-op strategy (do nothing)

Returns

TransferResult

objectSchema()

objectSchema: (ctx) => Promise<TransferResult>

Transfer object schema from source to target

Parameters

ctx

TransferContext

Returns

Promise<TransferResult>

objectSchemaAndValue()

objectSchemaAndValue: (ctx) => Promise<TransferResult>

Transfer both schema and value for objects

Parameters

ctx

TransferContext

Returns

Promise<TransferResult>

objectSchemaReset()

objectSchemaReset: (ctx) => Promise<TransferResult>

Parameters

ctx

TransferContext

Returns

Promise<TransferResult>

resetUnderlyingType()

resetUnderlyingType: (ctx) => TransferResult

Parameters

ctx

TransferContext

Returns

TransferResult

setUnderlyingType()

setUnderlyingType: (ctx) => Promise<TransferResult>

Set underlying type on AnyPort

Parameters

ctx

TransferContext

Returns

Promise<TransferResult>

streamConfigAndValue()

streamConfigAndValue: (ctx) => Promise<TransferResult>

Transfer stream configuration and value

Parameters

ctx

TransferContext

Returns

Promise<TransferResult>

streamItemConfig()

streamItemConfig: (ctx) => TransferResult

Transfer stream item configuration

Parameters

ctx

TransferContext

Returns

TransferResult

tryFirst()

tryFirst: (...strategies) => TransferStrategy

Try multiple strategies until one succeeds

Parameters

strategies

...TransferStrategy[]

Returns

TransferStrategy

underlyingTypeAndValue()

underlyingTypeAndValue: (ctx) => Promise<TransferResult>

Set underlying type and transfer value

Parameters

ctx

TransferContext

Returns

Promise<TransferResult>

updateArrayItems()

updateArrayItems: (ctx) => Promise<TransferResult>

Update array items after configuration or value changes

Parameters

ctx

TransferContext

Returns

Promise<TransferResult>

value()

value: (ctx) => TransferResult

Transfer only the value from source to target

Parameters

ctx

TransferContext

Returns

TransferResult

when()

when: (condition, thenStrategy, elseStrategy?) => TransferStrategy

Conditional strategy execution

Parameters

condition

(ctx) => boolean

thenStrategy

TransferStrategy

elseStrategy?

TransferStrategy

Returns

TransferStrategy

Licensed under BUSL-1.1