Bridge
Defined in: packages/ai.matey.types/src/bridge.ts:280
The Bridge connects frontend and backend adapters with routing and middleware.
Type Parameters
Section titled “Type Parameters”TFrontend
Section titled “TFrontend”TFrontend extends FrontendAdapter = FrontendAdapter
Frontend adapter type
Properties
Section titled “Properties”backend
Section titled “backend”
readonlybackend:BackendAdapter<unknown,unknown> |Router
Defined in: packages/ai.matey.types/src/bridge.ts:289
Backend adapter or router.
config
Section titled “config”
readonlyconfig:BridgeConfig
Defined in: packages/ai.matey.types/src/bridge.ts:294
Bridge configuration.
frontend
Section titled “frontend”
readonlyfrontend:TFrontend
Defined in: packages/ai.matey.types/src/bridge.ts:284
Frontend adapter for this bridge.
Methods
Section titled “Methods”chat()
Section titled “chat()”chat(
request,options?):Promise<InferFrontendResponse<TFrontend>>
Defined in: packages/ai.matey.types/src/bridge.ts:303
Execute a non-streaming chat completion request.
Parameters
Section titled “Parameters”request
Section titled “request”InferFrontendRequest<TFrontend>
options?
Section titled “options?”Returns
Section titled “Returns”Promise<InferFrontendResponse<TFrontend>>
chatStream()
Section titled “chatStream()”chatStream(
request,options?):AsyncGenerator<InferFrontendStreamChunk<TFrontend>,void,undefined>
Defined in: packages/ai.matey.types/src/bridge.ts:311
Execute a streaming chat completion request.
Parameters
Section titled “Parameters”request
Section titled “request”InferFrontendRequest<TFrontend>
options?
Section titled “options?”Returns
Section titled “Returns”AsyncGenerator<InferFrontendStreamChunk<TFrontend>, void, undefined>
clearMiddleware()
Section titled “clearMiddleware()”clearMiddleware():
Bridge<TFrontend>
Defined in: packages/ai.matey.types/src/bridge.ts:333
Clear all middleware from the stack.
Returns
Section titled “Returns”Bridge<TFrontend>
clone()
Section titled “clone()”clone(
config):Bridge<TFrontend>
Defined in: packages/ai.matey.types/src/bridge.ts:385
Clone bridge with new configuration.
Parameters
Section titled “Parameters”config
Section titled “config”Partial<BridgeConfig>
Returns
Section titled “Returns”Bridge<TFrontend>
dispose()
Section titled “dispose()”dispose():
void
Defined in: packages/ai.matey.types/src/bridge.ts:390
Clean up resources.
Returns
Section titled “Returns”void
getMiddleware()
Section titled “getMiddleware()”getMiddleware(): readonly
Middleware[]
Defined in: packages/ai.matey.types/src/bridge.ts:338
Get all middleware in the stack.
Returns
Section titled “Returns”readonly Middleware[]
getRouter()
Section titled “getRouter()”getRouter():
Router|null
Defined in: packages/ai.matey.types/src/bridge.ts:380
Get router instance (if backend is a router).
Returns
Section titled “Returns”Router | null
getStats()
Section titled “getStats()”getStats():
BridgeStats
Defined in: packages/ai.matey.types/src/bridge.ts:366
Get runtime statistics.
Returns
Section titled “Returns”off(
event,listener):Bridge<TFrontend>
Defined in: packages/ai.matey.types/src/bridge.ts:352
Unregister event listener.
Parameters
Section titled “Parameters”BridgeEventType | "*"
listener
Section titled “listener”Returns
Section titled “Returns”Bridge<TFrontend>
on(
event,listener):Bridge<TFrontend>
Defined in: packages/ai.matey.types/src/bridge.ts:347
Register event listener.
Parameters
Section titled “Parameters”BridgeEventType | "*"
listener
Section titled “listener”Returns
Section titled “Returns”Bridge<TFrontend>
once()
Section titled “once()”once(
event,listener):Bridge<TFrontend>
Defined in: packages/ai.matey.types/src/bridge.ts:357
Register one-time event listener.
Parameters
Section titled “Parameters”listener
Section titled “listener”Returns
Section titled “Returns”Bridge<TFrontend>
removeMiddleware()
Section titled “removeMiddleware()”removeMiddleware(
middleware):Bridge<TFrontend>
Defined in: packages/ai.matey.types/src/bridge.ts:328
Remove middleware from the stack.
Parameters
Section titled “Parameters”middleware
Section titled “middleware”Returns
Section titled “Returns”Bridge<TFrontend>
resetStats()
Section titled “resetStats()”resetStats():
void
Defined in: packages/ai.matey.types/src/bridge.ts:371
Reset statistics.
Returns
Section titled “Returns”void
use(
middleware):Bridge<TFrontend>
Defined in: packages/ai.matey.types/src/bridge.ts:323
Add middleware to the bridge’s middleware stack.
Parameters
Section titled “Parameters”middleware
Section titled “middleware”Returns
Section titled “Returns”Bridge<TFrontend>