Class Express

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

Access all of Express's functionality through the 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

Constructors

constructor

Properties

#keepAliveInterval? #programs #tasks ai? db? events express id log name server? structure?

Accessors

programs

Methods

deprogram keepAlive program run schedule task unschedule

Constructors

constructor

Properties

Private Optional #keepAliveInterval

#keepAliveInterval?: Timer

The interval of the keep alive function of the Brick instance. This is a private property used to store the interval of the keep alive function.

Private #programs

#programs: {
    [key: string]: Program;
}

The programs of the Brick instance. This is a private property used to store the programs that the Brick can run.

Type declaration

Private #tasks

#tasks: Task[] = []

The scheduled tasks of the Brick instance. This is a private property used to store the scheduled tasks that the Brick can run.

Optional ai

ai?: Intelligence

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

Optional db

db?: Database

The database of the Brick instance. This is used to manage the data storage and retrieval for the Brick.

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<LoggerOptions>

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.

Accessors

programs

  • get programs(): {
        [key: string]: Program;
    }

  • Returns the private map of programs.

    Returns {
        [key: string]: Program;
    }

Methods

deprogram

  • Removes a program from the private map of programs by its name.

    Parameters

    • name: string

      The name of the program to remove.

    Returns void

keepAlive

  • 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.

program

  • Adds a program to the private map of programs.

    Parameters

    • program: Program

      The program to add.

    Returns void

run

  • 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.

schedule

  • Schedules a Task to run on a given schedule. This is a wrapper around the node-cron package.

    Parameters

    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.

task

unschedule

  • 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.

Settings

Member Visibility

Theme

On This Page