mdl-ws-core-ts
TypeScript icon, indicating that this package has built-in type declarations

1.2.0 • Public • Published

mdl-ws-core-ts

Package to format service requests in Moodle WS format(https://docs.moodle.org/dev/Creating_a_web_service_client)

Installation

This is a Node.js module available through the npm registry.

Before installing, download and install Node.js.

If this is a brand new project, make sure to create a package.json first with the npm init command.

Installation is done using the npm install command:

$ npm install mdl-ws-core-ts

Debug errors Information

To activate debug options.

Go to moodle -> site administration -> developer -> debugging

In debugging messages select developer options.

Examples

General use

import {core} from "mdl-ws-core-ts";

const response = await core({
  URLRequest: {
    rootURL: 'http://localhost/moodle',
    token: 'aeb315e6dd3affc18352fe46124cdd48',
    wSFunction: 'core_course_get_courses',
  },
  content: {
    courses: [
        {
            fullname: 'Example01',
            shortname: 'Example1',
            categoryid: 1
        },
        {
            fullname: 'Example02',
            shortname: 'Example2',
            categoryid: 1
        }
    ]
  },
});

Use with other request methods

import core from "moodle-ws-core-ts";

const response = await core({
  URLRequest: {
    rootURL: 'http://localhost/moodle',
    token: 'aeb315e6dd3affc18352fe46124cdd48',
    wSFunction: 'core_course_get_courses',
  },
  content: {
    courses: [
        {
            fullname: 'Example01',
            shortname: 'Example1',
            categoryid: 1
        },
        {
            fullname: 'Example02',
            shortname: 'Example2',
            categoryid: 1
        }
    ]
  },
  method: 'POST'
});

Package Sidebar

Install

npm i mdl-ws-core-ts

Weekly Downloads

13

Version

1.2.0

License

ISC

Unpacked Size

18.1 kB

Total Files

14

Last publish

Collaborators

  • hector.arrechea21