Class default

Class representing a brick that sets up an Express server. It extends from the intellibrix!Brick class.

Access all of Express's functionality through the ExpressBrick.express property.

Example

const brick = new ExpressBrick({
  port: 3000,
  routes: [
    {
      path: '/',
      method: 'get',
      handler: (req, res) => {
        res.status(200).send('Hello World')
      }
    },
    {
      path: '/echo',
      method: 'post',
      handler: (req, res) => {
        res.status(200).json(req.body)
      }
    }
  ]
})

Hierarchy

Brick
- default

Index

Constructors

constructor

new default(options?: ExpressBrickOptions): default
Creates a new ExpressBrick.
Parameters
- options: ExpressBrickOptions = ...
  The options for the ExpressBrick.
  
  Interface for the options of ExpressBrick. It extends from BrickOptions and adds properties specific to ExpressBrick.
  - OptionalbuiltinMiddleware?: { json: boolean; urlencoded: boolean }
    
    An object specifying whether to use built-in middleware functions.
    
    json: boolean
    
    Whether to use the built-in JSON middleware.
    
    urlencoded: boolean
    
    Whether to use the built-in URL-encoded middleware.
  - Optionaldatabase?: KeyValueStore
    
    The key-value store of the Brick instance. Defaults to an in-memory store.
  - Optionalhost?: string
    
    The host on which the Express server will listen.
  - Optionalid?: string
    
    The unique identifier of the Brick instance. If not provided, a random UUID will be generated.
  - Optionalintelligence?: Intelligence
    
    The Intelligence of the Brick instance. This is used to manage the AI capabilities of the Brick.
  - OptionallogJSON?: boolean
    
    A boolean indicating whether the logs should be in JSON format.
  - OptionallogLevel?: Level
    
    The log level of the Brick instance. This determines the level of detail of the logs.
  - Optionalmiddleware?: RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>[]
    
    An array of middleware functions to use in the Express application.
  - Optionalname?: string
    
    The name of the Brick instance. If not provided, the id will be used as the name.
  - OptionalpinoOptions?: LoggerOptions<never>
    
    The options for the pino logger used by the Brick instance.
  - Optionalport?: number
    
    The port on which the Express server will listen.
  - Optionalroutes?: { handler: (req: Request, res: Response) => void; method: string; path: string }[]
    
    An array of routes that the Express server will handle.
  - Optionalstructure?: Structure
    
    The parent Structure of the Brick, if any.
Returns default

Remarks
Supports all BrickOptions as well as ExpressBrickOptions.
Overrides Brick.constructor
- Defined in packages/express/src/index.ts:189

Properties

`Optional`ai

ai?: Intelligence

The intelligence of the Brick instance. This is used to manage the AI capabilities of the Brick.

db

db: KeyValueStore

The key-value store of the Brick instance.

events

events: EventEmitter

The event emitter of the Brick instance. This is used to emit events that occur in the Brick, such as the running of a program.

express

express: Application

The Express application instance.

id

id: string

The unique identifier of the Brick instance.

log

log: Logger

The logger used by the Brick instance. This is used to log information about the operation of the Brick.

name

name: string

The name of the Brick instance.

`Optional`server

server?: Server<typeof IncomingMessage, typeof ServerResponse>

The HTTP server instance.

`Optional`structure

structure?: Structure

The parent Structure of the Brick instance, if any.

usage

usage: UsageAccumulator

Accumulates token usage/cost across every ask() call on this Brick. Starts as a .child() of this.ai.usage when an Intelligence is configured (so totals also roll up there), or standalone otherwise. Rebound as a .child() of the parent Structure's usage when added to one via Structure.add().

Accessors

programs

get programs(): { [key: string]: Program }
Returns the private map of programs.

Returns { [key: string]: Program }
Inherited from Brick.programs
- Defined in packages/core/dist/index.d.mts:557

Methods

ask

ask(prompt: string, options?: AskOptions): Promise<AskResult>
Runs a prompt through this Brick's ai, offering its programs (via Brick.tools) plus any tools attached via Brick.use.
Parameters
- prompt: string
- Optionaloptions: AskOptions
Returns Promise<AskResult>
Inherited from Brick.ask
- Defined in packages/core/dist/index.d.mts:596

askEndpoint

askEndpoint(path?: string, target?: AskTarget): default
Registers POST <path> (default /ask) answering with askRoute. Defaults to this brick as the target.
Parameters
- path: string = '/ask'
- target: AskTarget = ...
Returns default
- Defined in packages/express/src/index.ts:238

askStreamEndpoint

askStreamEndpoint(path?: string, target?: AskTarget): default
Registers GET <path> (default /ask/stream) streaming with askStreamRoute. Defaults to this brick as the target.
Parameters
- path: string = '/ask/stream'
- target: AskTarget = ...
Returns default
- Defined in packages/express/src/index.ts:247

deprogram

deprogram(name: string): void
Removes a program from the private map of programs by its name.
Parameters
- name: string
  The name of the program to remove.
Returns void
Inherited from Brick.deprogram
- Defined in packages/core/dist/index.d.mts:576

keepAlive

keepAlive(on: boolean): void
Toggles the keep alive flag of the Brick instance, which will prevent the Node process from exiting
Parameters
- on: boolean
  A boolean indicating whether to turn the keep alive flag on or off.
Returns void

Remarks
This is useful if you don't have a server or something else keeping the Node process alive.
Inherited from Brick.keepAlive
- Defined in packages/core/dist/index.d.mts:553

program

program(program: Program): void
Adds a program to the private map of programs.
Parameters
- program: Program
  The program to add.
Returns void
Inherited from Brick.program
- Defined in packages/core/dist/index.d.mts:571

run

run(name: string, payload: any): Promise<any>
Runs a program by its name with a given payload.
Parameters
- name: string
  The name of the program to run.
- payload: any
  The payload to pass to the program.
Returns Promise<any>
The result of the program.
Inherited from Brick.run
- Defined in packages/core/dist/index.d.mts:566

schedule

schedule(task: Task): Task
Schedules a Task to run on a given schedule. This is a wrapper around the cron package.
Parameters
- task: Task
  The Task to schedule.
Returns Task
The scheduled task.

Remarks
The task will run on the schedule provided, and will run the method provided with the Brick instance as the first argument.

Throws
An error if the task already exists.
Inherited from Brick.schedule
- Defined in packages/core/dist/index.d.mts:610

task

task(name: string): Task | undefined
Returns a Task by its name.
Parameters
- name: string
Returns Task | undefined
Inherited from Brick.task
- Defined in packages/core/dist/index.d.mts:600

tools

tools(): ToolDefinition[]
Exposes every registered program as a ToolDefinition, each execute calling this.run(program.name, input).

Returns ToolDefinition[]
Inherited from Brick.tools
- Defined in packages/core/dist/index.d.mts:581

toolset

toolset(): ToolDefinition[]
Every tool this Brick offers: its programs (via Brick.tools) plus anything attached via Brick.use.

Returns ToolDefinition[]
Inherited from Brick.toolset
- Defined in packages/core/dist/index.d.mts:586

unschedule

unschedule(name: string): void
Unschedules a task by its name.
Parameters
- name: string
  The name of the task to unschedule.
Returns void

Throws
An error if the task does not exist.
Inherited from Brick.unschedule
- Defined in packages/core/dist/index.d.mts:617

use

use(...toolsets: ToolDefinition[][]): this
Attaches external tool arrays (e.g. MCP-sourced tools) to this Brick, included whenever ask() builds its tool list.
Parameters
- ...toolsets: ToolDefinition[][]
Returns this
Inherited from Brick.use
- Defined in packages/core/dist/index.d.mts:591

Class default

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

OptionalbuiltinMiddleware?: { json: boolean; urlencoded: boolean }

json: boolean

urlencoded: boolean

Optionaldatabase?: KeyValueStore

Optionalhost?: string

Optionalid?: string

Optionalintelligence?: Intelligence

OptionallogJSON?: boolean

OptionallogLevel?: Level

Optionalmiddleware?: RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>[]

Optionalname?: string

OptionalpinoOptions?: LoggerOptions<never>

Optionalport?: number

Optionalroutes?: { handler: (req: Request, res: Response) => void; method: string; path: string }[]

Optionalstructure?: Structure

Returns default

Remarks

Properties

Optionalai

db

events

express

id

log

name

Optionalserver

Optionalstructure

usage

Accessors

programs

Returns { [key: string]: Program }

Methods

ask

Parameters

Returns Promise<AskResult>

askEndpoint

Parameters

Returns default

askStreamEndpoint

Parameters

Returns default

deprogram

Parameters

Returns void

keepAlive

Parameters

Returns void

Remarks

program

Parameters

Returns void

run

Parameters

Returns Promise<any>

schedule

Parameters

Returns Task

Remarks

Throws

task

Parameters

Returns Task | undefined

tools

Returns ToolDefinition[]

toolset

Returns ToolDefinition[]

unschedule

Parameters

Returns void

`Optional`builtinMiddleware?: { json: boolean; urlencoded: boolean }

`Optional`database?: KeyValueStore

`Optional`host?: string

`Optional`id?: string

`Optional`intelligence?: Intelligence

`Optional`logJSON?: boolean

`Optional`logLevel?: Level

`Optional`middleware?: RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>[]

`Optional`name?: string

`Optional`pinoOptions?: LoggerOptions<never>

`Optional`port?: number

`Optional`routes?: { handler: (req: Request, res: Response) => void; method: string; path: string }[]

`Optional`structure?: Structure

`Optional`ai

`Optional`server

`Optional`structure