Function

Static Public Summary
public	getSchools(query: string): Promise<School[]> Get the schools matching `query`.
public	magister(options: Object): Promise<Magister> Create a new Magister object using `options`.

Static Public

import {getSchools} from 'magister.js/src/magister.js'

Get the schools matching query.

Name	Type	Attribute	Description
query	string

import magister from 'magister.js/src/magister.js'

Create a new Magister object using options.

Name	Type	Attribute	Description
options	Object
options.school	School		The school to login to.
options.username	string	optional	The username of the user to login to.
options.password	string	optional	The password of the user to login to.
options.token	string	optional	The Bearer token to use. (instead of the username and password)
options.keepLoggedIn	boolean	optional default: true	Whether or not to keep the user logged in.
options.login	boolean	optional default: true	Whether or not to call login before returning the object.
options.authCode	string	optional default: AuthCode	The AuthCode that Magister uses in their requests. Per default we use the value from the @magisterjs/authcode package. Which you should keep up-to-date.