moodle-console

Moodle Client Console

This is a package provides you an event based Console in Moodle wich you can write and receive messages from. The Console is based on the akora-moodle package and has built-in typings, it is simple, fast and lightweight.

How does it work?

This console works by sending messages to yourself on Moodle, the Client receives your new message and you can execute some code with the message.

Why should i use this package?

Bcs implementing this on your own would take quite a while and it just would be faster to use this package. You may ask, "What if i want to have a function that the package does not provide?", we would love to implement your hopefully usefull function and constantly improve our package, so feel free to open a Issue or an Feature Request.

Getting started

Installation

npm install moodle-console

Creating an instance

To create a instance of the ConsoleClient, first need a instance of a Client from the akora-moodle package, which you need provide in the constructor. More information on creating a Client can be found here.

The most basic setup would be

const { ConsoleClient } = require('moodle-console')
const { Client } = require('akora-moodle');

Client.init({
   wwwroot: 'https://moodle.your-school.de/',
   token: 'yourtokengoesbrrrrrr'
}).then(async client => {
    var con = new ConsoleClient(client);
    await con.initConsole();

    con.send({
        text: 'Hello World'
    })
})

Listening to messages

The ConsoleClient is a EventEmitter which means that you can listen to events with .on('event', callback), currently only the message event is supported

Ping Pong!

var con = new ConsoleClient(client);
con.initConsole().then(async () => {
    await con.send({
        text: '**Started the Console!**'
    })
    
    con.on('message', async (message) => {
        await con.send({ text: 'Pong!' });
    });
})

This would write back Pong every time you send a message to yourself in moodle.