es-api v0.1.0

es-api

es-api is a wrapper for Enriching Students API, written in TypeScript.

Documentation

You can view the docs here

Installation

Use NPM to install es-api.

npm i es-api

Example

Also view examples

import {EsAPI} from './client'

const api = new EsAPI()

api.status.on('ready', () => {
    api.schoolMessage()
        .then(message => {
            console.log(message);
        })
})

api.login({email: 'EMAIL', password: 'PASS'})

You can also use your token!

import {EsAPI} from './client'

const api = new EsAPI()

api.status.on('ready', () => {
    api.schoolMessage()
        .then(message => {
            console.log(message);
        })
})

api.login({token: 'token'})

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

GNU General Public License v3.0