moodle.js

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 8 Open GitHub ↗

This is a simple Client for moodle, that is inspired by the moodle-client by mudrd8mz, it has built-in typings and typings for many endpoints of the Moodle API.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![NPM Version](https://img.shields.io/npm/v/moodle.js?color=00DEC8&style=for-the-badge)](https://www.npmjs.com/package/moodle.js)
[![NPM Downloads](https://img.shields.io/npm/dt/moodle.js?color=00DEC8&style=for-the-badge)](https://www.npmjs.com/package/moodle.js)
[![NPM License](https://img.shields.io/npm/l/moodle.js?color=00DEC8&style=for-the-badge)](https://www.npmjs.com/package/moodle.js)
[![Github Size](https://img.shields.io/github/repo-size/discord-card/levelcard?color=00DEC8&label=SIZE&style=for-the-badge)](https://www.npmjs.com/package/moodle.js)

# Moodle.JS

This is a simple Client for moodle, that is inspired by the [moodle-client](https://www.npmjs.com/package/moodle-client) by [mudrd8mz](https://www.npmjs.com/~mudrd8mz), it has built in typings and typings for many endpoints of the Moodle API(which are documented [here](https://learn.cineca.it/pluginfile.php/1/theme_adaptable/adaptablemarketingimages/0/api.htm)), the typings will be extended in the future till hopefully one day al endpoints are built in this package.

> The Documentation is also available on [GitBook](https://dragoncatm.gitbook.io/moodle/)

## Why should i use this package?

If you ever read the documentation of the Moodle API, then you know that there are hundrets of methods and if you dont have the right documentation the [docs](https://docs.moodle.org) can be hard to read and understand, you still need the documentation to use this package but it provides you most methods with built in types so that you know what you get back and what you need to supply to the request.

# Getting started

## Installation

```bash
npm install moodle.js
```

## Creating an instance

To create an instance of the Client, you use the static `init` method of the Client with an object which contains all needed options to initialize the client. The method will return a Promise wich returns a instance of the `Client` class.

<details open><summary>Here an example of an basic Login with your username, and password.</summary>

> ```js
> const { Client } = require('moodle.js');
>
> Client.init({
>     wwwroot: 'https://moodle.your-school.de/',
>     username: 'Bob',
>     password: 'SuPeRsecRet'
> });
> ```

</details>

<details open><summary>You can also log in with a token. (If credentials and token are provided token will be used).</summary>

> ```js
> Client.init({
>     wwwroot: 'https://moodle.your-school.de/',
>     token: 'yourtokengoesbrrrrrr'
> });
> ```

</details>

---

## Built-in Methods

At the moment all implemented methods can be found in the `client.core` property, your IDE will tell you what methods are already implemented and usable, as well as your IDE will tell you what arguments you need to provide and what the response looks like.

<details><summary>Here is a short example which gives you informations about the current logged in user.</summary>

> ```js
> const { Client } = require('moodle.js');
>
> Client.init({
>     wwwroot: 'https://moodle.your-school.de/',
>     token: 'yourtokengoesbrrrrrr'
> })
>     .then(async (client) => {
>         var info = await client.core.getInfo();
>
>         console.log('You are Logged in as %s %s', info.firstname, info.lastname);
>     })
>     .catch((err) => {
>         console.log('Something went wrong ._.', err);
>     });
> ```

</details>

<details><summary>Here is a short example which returns you an array of course contents.</summary>

> ```js
> const { Client } = require('moodle.js');
>
> client
>     .init({
>         wwwroot: 'https://moodle.your-school.de/',
>         token: 'yourtokengoesbrrrrrr'
>     })
>     .then(async (client) => {
>         var contents = await client.core.course.getContents({
>             courseid: 3272
>         });
>
>         console.log('There are %s Sections in this Course', contents.length);
>     })
>     .catch((err) => {
>         console.log('Something went wrong ._.', err);
>     });
> ```

</details>

---

## Custom API Calls

At the moment not even nearly all methods are implemented, so you might often want to use the `client.call` method to make a custom API Requests.

<details><summary>An example</summary>

> ```js
> const { Client } = require('moodle.js');
>
> Client.init({
>     wwwroot: 'https://moodle.your-school.de/',
>     token: 'yourtokengoesbrrrrrr'
> })
>     .then(async (client) => {
>         var response = await client.call({
>             wsfunction: 'core_not_implemented_yet',
>             method: 'POST',
>             args: {
>                 someid: 123
>             }
>             //You can also provide settings > for advanced usage
>         });
>     })
>     .catch((err) => {
>         console.log('Something went wrong ._.', err);
>     });
> ```

</details>

---

## Advanced Client settings

<details><summary>All custom Settings</summary>

> ```js
> const { Client } = require('moodle.js');
>
> Client.init({
>     wwwroot: 'https://moodle.your-school.de/',
>     token: 'yourtokengoesbrrrrrr',
>     // The web service to use, default is moodle_mobile_app
>     service: 'moodle_mobile_app',
>     // If set to false, SSL certificates do not need to be valid.
>     strictSSL: true,
>     // Will enable the built-in Logger
>     logger: true
> });
> ```

</details>

moodle.js

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README