Class Terminal

Class representing a Terminal Brick. It extends from the Brick class.

It uses the TerminalKit library to interact with the terminal.

Example

const terminalBrick = new TerminalBrick({ logLevel: 'silent' })

while (true) {
  terminalBrick.print('> ')
  const input = await terminalBrick.input()

  switch (input.toLowerCase()) {
    case 'exit':
      terminalBrick.printSuccess('Bye!')
      process.exit()
    case 'error':
      terminalBrick.printError('Error!')
      break
    case 'yellow':
      terminalBrick.terminal.yellow('Yellow!')
      break
    default:
      terminalBrick.printLine(`Command: ${input}`)
  }
}

Hierarchy

Brick
- Terminal

Index

Constructors

constructor

new Terminal(options?): Terminal
Creates a new Terminal Brick.
Parameters
- options: BrickOptions = {}
  
  The options for the Terminal Brick.
Returns Terminal
Overrides Brick.constructor
- Defined in src/bricks/terminal.ts:42

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

[key: string]: Program

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

id

id: string

The unique identifier of the Brick instance.

kit

kit: __module

The TerminalKit module.

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` structure

structure?: Structure

The parent Structure of the Brick instance, if any.

terminal

terminal: Terminal

The TerminalKit terminal instance.

Accessors

programs

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

Returns {
[key: string]: Program;
}
- [key: string]: Program
Inherited from Brick.programs
- Defined in src/brick.ts:216

Methods

deprogram

deprogram(name): 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 src/brick.ts:262

input

input(inputOptions?): Promise<string>
Prompts the user for input in the terminal.
Parameters
- inputOptions: InputFieldOptions = {}
  
  The options for the input field.
Returns Promise<string>
A promise that resolves to the user's input.
- Defined in src/bricks/terminal.ts:110

keepAlive

keepAlive(on): 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 src/brick.ts:208

print

print(text): void
Prints some text to the terminal.
Parameters
- text: string
  
  The text to print.
Returns void
- Defined in src/bricks/terminal.ts:53

printDebug

printDebug(text): void
Prints a debug message to the terminal in cyan color.
Parameters
- text: string
  
  The debug message to print.
Returns void
- Defined in src/bricks/terminal.ts:101

printError

printError(text): void
Prints an error message to the terminal in red color.
Parameters
- text: string
  
  The error message to print.
Returns void
- Defined in src/bricks/terminal.ts:69

printInfo

printInfo(text): void
Prints an info message to the terminal in blue color.
Parameters
- text: string
  
  The info message to print.
Returns void
- Defined in src/bricks/terminal.ts:93

printLine

printLine(text): void
Prints a line of text to the terminal.
Parameters
- text: string
  
  The text to print.
Returns void
- Defined in src/bricks/terminal.ts:61

printSuccess

printSuccess(text): void
Prints a success message to the terminal in green color.
Parameters
- text: string
  
  The success message to print.
Returns void
- Defined in src/bricks/terminal.ts:77

printWarning

printWarning(text): void
Prints a warning message to the terminal in yellow color.
Parameters
- text: string
  
  The warning message to print.
Returns void
- Defined in src/bricks/terminal.ts:85

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 src/brick.ts:249

run

run(name, payload): 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 src/brick.ts:226

schedule

schedule(task): Task
Schedules a Task to run on a given schedule. This is a wrapper around the node-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 src/brick.ts:286

task

task(name): undefined | Task
Returns a Task by its name.
Parameters
- name: string
Returns undefined | Task
Inherited from Brick.task
- Defined in src/brick.ts:273

unschedule

unschedule(name): 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 src/brick.ts:304

Class Terminal

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: BrickOptions = {}

Returns Terminal

Properties

Private Optional #keepAliveInterval

Private #programs

Type declaration

[key: string]: Program

Private #tasks

Optional ai

Optional db

events

id

kit

log

name

Optional structure

terminal

Accessors

programs

Returns { [key: string]: Program; }

[key: string]: Program

Methods

deprogram

Parameters

name: string

Returns void

input

Parameters

inputOptions: InputFieldOptions = {}

Returns Promise<string>

keepAlive

Parameters

on: boolean

Returns void

Remarks

print

Parameters

text: string

Returns void

printDebug

Parameters

text: string

Returns void

printError

Parameters

text: string

Returns void

printInfo

Parameters

text: string

Returns void

printLine

Parameters

text: string

Returns void

printSuccess

Parameters

text: string

Returns void

printWarning

Parameters

text: string

Returns void

program

Parameters

program: Program

Returns void

run

Parameters

`Private` `Optional` #keepAliveInterval

`Private` #programs

`Private` #tasks

`Optional` ai

`Optional` db

`Optional` structure

Returns {
[key: string]: Program;
}