Home Reference Source


Gitter npm version Known Vulnerabilities CodeFactor

A JavaScript implementation of the Magister 6 API.

Quickstart

npm install magister.js

const { default: magister, getSchools } = require('magister.js');
// or with es6 modules:
// import magister, { getSchools } from 'magister.js'

// replace every '<thing>' with your credentials:

getSchools('<schoolname>') // get schools matching '<schoolname>'
    .then((schools) => schools[0]) // get the first school
    .then((school) => magister({ // login
        school,
        username: '<username>',
        password: '<password>',
    }))
    .then((m) => { // done logging in, say hi
        console.log(`Hey ${m.profileInfo.firstName}!`);
    }, (err) => { // something went wrong
        console.error('something went wrong:', err);
    });

Useful links

Before creating issues

  1. Update all your packages with npm update
  2. Be sure you haven't made a typo and your code is correct (check the docs)
  3. Don't create issues which occur in a modified version

Contributing

License

LGPLv3