Skip to content

flowMapper

@waldiez/react v0.4.8


const flowMapper: object

Defined in: src/waldiez/models/mappers/flow/flowMapper.ts:50

Mapper for WaldiezFlow, providing methods to import and export flows, convert to React Flow format, and extract flow data.

Type declarationΒΆ

exportFlow()ΒΆ

exportFlow: (flow, hideSecrets, skipLinks) => WaldiezFlow

Convert a react flow instance to a WaldiezFlow.

ParametersΒΆ
flowΒΆ

WaldiezFlowProps

hideSecretsΒΆ

boolean

boolean = false

ReturnsΒΆ

WaldiezFlow

The WaldiezFlow instance

importFlow()ΒΆ

importFlow: (item, newId?) => WaldiezFlow

Import a flow from a JSON object or string.

ParametersΒΆ
itemΒΆ

any

newId?ΒΆ

string

ReturnsΒΆ

WaldiezFlow

The imported flow

toReactFlow()ΒΆ

toReactFlow(flow): WaldiezFlowProps

Convert a WaldiezFlow to WaldiezFlowProps for use with React Flow.

ParametersΒΆ
flowΒΆ

WaldiezFlow

ReturnsΒΆ

WaldiezFlowProps

The WaldiezFlowProps compatible with React Flow

SeeΒΆ