Class I18n

Class representing an I18n (Internationalization) Brick. It extends from the Brick class.

Example

const brick = new I18nBrick({ resources: { es: { translation: { 'Hello': 'Hola' } } } })
brick.language = 'es'
console.log(brick.t('Hello')) // 'Hola'

Hierarchy

Brick
- I18n

Index

Constructors

constructor

new I18n(options?): I18n
Creates a new I18n Brick.
Parameters
- options: I18nBrickOptions = ...
  
  The options for the I18n Brick.
Returns I18n
Overrides Brick.constructor
- Defined in src/bricks/i18n.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.

i18next

i18next: any

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

structure?: Structure

The parent Structure of the Brick instance, if any.

t

t: ((key, options?) => void)

Type declaration

- (key, options?): void
- The translation function.
  Parameters
  - key: string
  - Optional options: any
  Returns void

Accessors

language

get language(): string
Gets the current language of the I18n Brick.

Returns string
- Defined in src/bricks/i18n.ts:65
set language(language): void
Sets the current language of the I18n Brick.
Parameters
- language: string
Returns void
- Defined in src/bricks/i18n.ts:72

languages

get languages(): readonly string[]
Gets the languages supported by the I18n Brick.

Returns readonly string[]
- Defined in src/bricks/i18n.ts:58

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

get

get(text): string
Translates text using the current language.
Parameters
- text: string
  
  The text to translate.
Returns string
- Defined in src/bricks/i18n.ts:80

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

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 I18n

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: I18nBrickOptions = ...

Returns I18n

Properties

Private Optional #keepAliveInterval

Private #programs

Type declaration

[key: string]: Program

Private #tasks

Optional ai

Optional db

events

i18next

id

log

name

Optional structure

t

Type declaration

Parameters

key: string

Optional options: any

Returns void

Accessors

language

Returns string

Parameters

language: string

Returns void

languages

Returns readonly string[]

programs

Returns { [key: string]: Program; }

[key: string]: Program

Methods

deprogram

Parameters

name: string

Returns void

get

Parameters

text: string

Returns string

keepAlive

Parameters

on: boolean

Returns void

Remarks

program

Parameters

program: Program

Returns void

run

Parameters

name: string

payload: any

Returns Promise<any>

schedule

Parameters

task: Task

Returns Task

Remarks

Throws

task

Parameters

name: string

Returns undefined | Task

unschedule

Parameters

name: string

`Private` `Optional` #keepAliveInterval

`Private` #programs

`Private` #tasks

`Optional` ai

`Optional` db

`Optional` structure

`Optional` options: any

Returns {
[key: string]: Program;
}