intellibrix v1.0.0
    Preparing search index...

    Class I18nBrick

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

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

    Hierarchy

    • Brick
      • I18nBrick
    Index
    constructor
    ai? db events i18next id initPromise log name structure? t usage
    language languages programs
    ask deprogram get keepAlive program run schedule task tools toolset unschedule use create
    ai?: Intelligence

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

    db: KeyValueStore

    The key-value store of the Brick instance.

    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: i18n

    This brick's own i18next instance (never the global singleton).

    id: string

    The unique identifier of the Brick instance.

    initPromise: Promise<TFunction<"translation", undefined>>

    Resolves once i18next has finished initializing.

    log: Logger

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

    name: string

    The name of the Brick instance.

    structure?: Structure

    The parent Structure of the Brick instance, if any.

    t: TFunction

    The translation function, bound to this brick's instance.

    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().

    • get language(): string

      Gets the current language of the I18n Brick.

      Returns string

    • set language(language: string): void

      Sets the current language of the I18n Brick.

      Parameters

      • language: string

      Returns void

    • get languages(): readonly string[]

      Gets the languages supported by the I18n Brick.

      Returns readonly string[]

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

      Returns the private map of programs.

      Returns { [key: string]: Program }

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

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

      Parameters

      • name: string

        The name of the program to remove.

      Returns void

    • Translates text using the current language.

      Parameters

      • text: string

        The text to translate.

      Returns string

    • 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

      This is useful if you don't have a server or something else keeping the Node process alive.

    • Adds a program to the private map of programs.

      Parameters

      • program: Program

        The program to add.

      Returns void

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

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

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

      An error if the task already exists.

    • Returns a Task by its name.

      Parameters

      • name: string

      Returns Task | undefined

    • Exposes every registered program as a ToolDefinition, each execute calling this.run(program.name, input).

      Returns ToolDefinition[]

    • Every tool this Brick offers: its programs (via Brick.tools) plus anything attached via Brick.use.

      Returns ToolDefinition[]

    • Unschedules a task by its name.

      Parameters

      • name: string

        The name of the task to unschedule.

      Returns void

      An error if the task does not exist.

    • Attaches external tool arrays (e.g. MCP-sourced tools) to this Brick, included whenever ask() builds its tool list.

      Parameters

      • ...toolsets: ToolDefinition[][]

      Returns this

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods