Skip to content

ChainGraph API Documentation / @badaitech/chaingraph-trpc / server / IFlowStore

Interface: IFlowStore ​

Defined in: packages/chaingraph-trpc/server/stores/flowStore/types.ts:15

Interface for flow storage implementations

Properties ​

createFlow() ​

createFlow: (metadata) => Promise<Flow>

Defined in: packages/chaingraph-trpc/server/stores/flowStore/types.ts:16

Parameters ​

metadata ​

FlowMetadata

Returns ​

Promise<Flow>


deleteFlow() ​

deleteFlow: (flowId) => Promise<boolean>

Defined in: packages/chaingraph-trpc/server/stores/flowStore/types.ts:24

Parameters ​

flowId ​

string

Returns ​

Promise<boolean>


getFlow() ​

getFlow: (flowId) => Promise<Flow | null>

Defined in: packages/chaingraph-trpc/server/stores/flowStore/types.ts:17

Parameters ​

flowId ​

string

Returns ​

Promise<Flow | null>


getFlowMetadata() ​

getFlowMetadata: (flowId) => Promise<FlowMetadata | null>

Defined in: packages/chaingraph-trpc/server/stores/flowStore/types.ts:18

Parameters ​

flowId ​

string

Returns ​

Promise<FlowMetadata | null>


hasAccess() ​

hasAccess: (flowId, userId) => Promise<boolean>

Defined in: packages/chaingraph-trpc/server/stores/flowStore/types.ts:26

Parameters ​

flowId ​

string

userId ​

string

Returns ​

Promise<boolean>


listFlows() ​

listFlows: (ownerId, orderBy, limit) => Promise<FlowMetadata[]>

Defined in: packages/chaingraph-trpc/server/stores/flowStore/types.ts:19

Parameters ​

ownerId ​

string

orderBy ​

ListOrderBy

limit ​

number

Returns ​

Promise<FlowMetadata[]>


lockFlow() ​

lockFlow: (flowId, timeout?) => Promise<void>

Defined in: packages/chaingraph-trpc/server/stores/flowStore/types.ts:28

Parameters ​

flowId ​

string

timeout? ​

number

Returns ​

Promise<void>


unlockFlow() ​

unlockFlow: (flowId) => Promise<void>

Defined in: packages/chaingraph-trpc/server/stores/flowStore/types.ts:29

Parameters ​

flowId ​

string

Returns ​

Promise<void>


updateFlow() ​

updateFlow: (flow) => Promise<Flow>

Defined in: packages/chaingraph-trpc/server/stores/flowStore/types.ts:25

Parameters ​

flow ​

Flow

Returns ​

Promise<Flow>

Licensed under BUSL-1.1