Skip to main content

@maiar-ai/core / TriggerRoute

Interface: TriggerRoute

Defined in: packages/core/src/runtime/providers/plugin.types.ts:46

Implementation of a trigger for a plugin. Listens for HTTP requests OR process triggers, then creates an event invoke the MAIAR agent.

Properties​

name​

name: string

Defined in: packages/core/src/runtime/providers/plugin.types.ts:50

Unique identifier for the trigger.


route​

route: object

Defined in: packages/core/src/runtime/providers/plugin.types.ts:55

HTTP route configuration for the trigger.

path​

path: string

The path of the route.

handler()​

handler: (req, res) => void | Promise<void>

The handler for the route.

Parameters​
req​

Request

res​

Response

Returns​

void | Promise<void>

middleware?​

optional middleware: RequestHandler | RequestHandler[]

Optional middleware to apply before the handler. Defaults to express.raw if not provided.


start?​

optional start: undefined

Defined in: packages/core/src/runtime/providers/plugin.types.ts:76

Start is of type never because it is not used in the TriggerRoute type.