Class SuiPlugin

Hierarchy

Plugin
- SuiPlugin

Index

Constructors

Properties

handlers name supportedHandlers

Methods

configure preprocessBinding processBinding processSuiEvent processSuiFunctionCall processSuiObject processSuiObjectChange shutdownServer start startServer stateDiff

Constructors

constructor

new SuiPlugin(): SuiPlugin
Returns SuiPlugin
Inherited from Plugin.constructor

Properties

handlers

handlers: Handlers = ...

name

name: string = 'SuiPlugin'

supportedHandlers

supportedHandlers: HandlerType[] = ...

Methods

configure

configure(config: ProcessConfigResponse): Promise<void>
Parameters
- config: ProcessConfigResponse
Returns Promise<void>
Overrides Plugin.configure
- Defined in packages/sdk/src/sui/sui-plugin.ts:74

preprocessBinding

preprocessBinding(
request: DataBinding,
preprocessStore: { [k: string]: any },
): Promise<PreprocessResult>
Parameters
- request: DataBinding
- preprocessStore: { [k: string]: any }
Returns Promise<PreprocessResult>
Inherited from Plugin.preprocessBinding
- Defined in packages/runtime/lib/index.d.ts:50

processBinding

processBinding(request: DataBinding): Promise<ProcessResult>
Parameters
- request: DataBinding
Returns Promise<ProcessResult>
Overrides Plugin.processBinding
- Defined in packages/sdk/src/sui/sui-plugin.ts:281

processSuiEvent

processSuiEvent(binding: DataBinding): Promise<ProcessResult>
Parameters
- binding: DataBinding
Returns Promise<ProcessResult>
- Defined in packages/sdk/src/sui/sui-plugin.ts:198

processSuiFunctionCall

processSuiFunctionCall(binding: DataBinding): Promise<ProcessResult>
Parameters
- binding: DataBinding
Returns Promise<ProcessResult>
- Defined in packages/sdk/src/sui/sui-plugin.ts:218

processSuiObject

processSuiObject(binding: DataBinding): Promise<ProcessResult>
Parameters
- binding: DataBinding
Returns Promise<ProcessResult>
- Defined in packages/sdk/src/sui/sui-plugin.ts:234

processSuiObjectChange

processSuiObjectChange(binding: DataBinding): Promise<ProcessResult>
Parameters
- binding: DataBinding
Returns Promise<ProcessResult>
- Defined in packages/sdk/src/sui/sui-plugin.ts:254

shutdownServer

shutdownServer(): void
method used by action server only

Returns void
Inherited from Plugin.shutdownServer
- Defined in packages/runtime/lib/index.d.ts:61

start

start(request: StartRequest): Promise<void>
Parameters
- request: StartRequest
Returns Promise<void>
Overrides Plugin.start
- Defined in packages/sdk/src/sui/sui-plugin.ts:47

startServer

startServer(port?: number): Promise<void>
method used by action server only
Parameters
- Optionalport: number
Returns Promise<void>
Inherited from Plugin.startServer
- Defined in packages/runtime/lib/index.d.ts:57

stateDiff

stateDiff(config: ProcessConfigResponse): boolean
Parameters
- config: ProcessConfigResponse
Returns boolean
Deprecated
The method should not be used, use ctx.states instead
Inherited from Plugin.stateDiff
- Defined in packages/runtime/lib/index.d.ts:48